SQL

Module name: sql

The GLConnectors SQL Connector provides a powerful and flexible way to connect to and query your SQL databases directly from GL Connectors' servers. By leveraging the robustness of SQLAlchemy, it supports a wide range of database systems, allowing you to seamlessly integrate your existing data infrastructure.

This guide will walk you through configuring and how to use the SQL Connector.

Configuration Parameters

You can configure a new database integration in two ways: by providing a full connection url or by specifying individual connection parameters.

When initiating the integration, you pass a configuration dictionary. If the url field is provided, all other connection-specific fields are ignored.

Required Fields

Using URL

This is the simplest method. Provide the full database connection string.

Required Fields:

• url: The full URL to the database, including the protocol and hostname.

config = {
    "url": "postgresql://myuser:mypassword@myhost:5432/mydatabase",
    "identifier": "My-Production-DB" # Optional, but highly recommended
}

Using Individual Parameters

Additional Optional Fields

• identifier: A custom string to help you identify this specific integration later. While this field is optional, it is highly recommended. If not provided, the identifier defaults to a concatenated string of connection details (driver:host:port:username:database), which can become long and difficult to read. Setting a clear, human-readable identifier is best practice.

• extra_config: A dictionary for any extra parameters required by the database driver (e.g., SSL settings).

Drivers

If the connection fails because we currently do not support the database (see below), please contact GL Connectors Team. As long as there is a driver available that can be installed that supports that SQL database type, we are willing to provide the support as needed.

Drivers must follow SQLAlchemy's supported engine that can be found here. The following database types have been tested:

Database Type	Driver Name
MySQL	mysql
MariaDB	mysql or mariadb
PostgreSQL	postgresql
AWS Athena	awsathena+rest
Microsoft SQL Server	mssql+pymssql

Usage Example

PostgreSQL

from gl_connectors_sdk.connector import GLConnectors

connector = GLConnectors(api_base_url="https://connector.gdplabs.id", api_key="your_api_key")

user_token = "a_unique_user_token"

has_integration = connector.user_has_integration("sql", user_token)

if not has_integration:
    print("User has no SQL integration. Initiating a new one...")

    config = {
        "url": "postgresql://postgres:postgres@localhost:5432/gl-connectors",
        "identifier": "PSQLGLConnectors" # A custom name for this integration
    }

    integration_result = connector.initiate_plugin_configuration("sql", user_token, config)
    print("Integration initiated:", integration_result)

else:
    print("User already has an SQL integration.")

# 4. Connect to the SQL service and execute a query
print("Executing query...")
sql = connector.connect('sql')

response = sql.action("query") \
    .token(user_token) \
    .params({
        "query": "SELECT * FROM third_party_integration_auths WHERE connector = :conn",
        "variables": {
            "conn": "sql"
        }
    }) \
    .execute()

print("Query response:", response)

Athena