Databricks

Lumi currently does NOT support Databricks and the following document covers the usage of the database within the application.

Supported Methods

Means for Lumi to connect to the client to implement the services required

• Direct

  This is the default option. This runs queries directly to the source, with no mediation. Make sure the source system allows for internet-based access (or whitelist Lumi AI; see rest of docs for specifics).

• Gateway This separate module is our tool to help connect to your data sources that are secured inside your network.

Supported Limits

The following are limits that can be configured for the system to moderate access and usage from users in Lumi AI:

• Cost Limit Before running a query, if the system supports it, the system-specific compute cost (or surrogate) estimate will be processed and compared to an organization-level/admin-set cost limit for systems of this type (if configured/set). If exceeded, the query will not run (and either the workflow will attempt an optimization or the user will be notified).

• Duration Limit An alternative to cost, queries will be stopped the system supports a duration/timeout limit and one is set/configured at the organization level (across systems).

Available Parameters

These properties are the essential source system connection properties that all queries are directed towards.

* Required parameters

Note: The Gateway parameter is common to all systems (when supported) and is only available when gateway is the selected connection method.

Host*

Domain or IP of the database to allow a connection to Lumi AI.

👍 Valid Examples

• Domain name: docs.lumi-ai.com

• IPv4: 55.88.92.101

👎 Invalid Examples

• IPv4 with alphanumeric characters: 123.abc.def.456

• Incomplete domain name resolutions: lumi-ai.com

Port*

Access port to allow for connections to the database.

👍 Valid Examples

• Default PostgreSQL port: 5432

👎 Invalid Examples

• Known Port Numbers (0-1023): 80

Username*

Username of the generated database user which will be used for interactions and transactions.

Special Considerations

• If double quotes are used, then the name will be case sensitive

👍 Valid Examples

• Uses alphanumeric characters : lumi1

• Utilizing underscore (_) in place of spaces: user_number

👎 Invalid Examples

• Starting with a number: 1lumi

• Utilizing spaces: user name

• Using invalid characters: user#1

Password*

Password of the generated database user which will be used for interactions and transactions.

Database*

Literal database name that will be used for transactions within the agents.

Special Considerations

• If case sensitivity is required, utilize double quotes for database name; ex. "New_database"

👍 Valid Examples

• Uses alphanumeric characters: lumi1

• Utilizing underscore (_) in place of spaces: new_database

👎 Invalid Examples

• Starting with a number: 1lumi

• Utilizing spaces: user name

• Using reserved words unquoted: select

System Permissions & Configuration

Provided user must have the following:

• If applicable CREATE a user

• Grant the user SELECT privileges on the schema and tables:

  • GRANT SELECT ON SCHEMA my_schema TO service_user; GRANT SELECT ON TABLE my_schema.my_table TO service_user;

For configurations:

• Ensure the server is allowing connections from the Lumi gateway or server via the firewall

Special Notes

• Special characters and case sensitivity can be utilized in database names and usernames via encasing the name in double quotes (" "), but is not recommended

Common Issues

• Ensure the firewall settings allow for a connection to the database

• Ensure the username, password, and database values are explicitly provided