Version 4.0.24.18 (latest)
Create a connection using the specified configuration.
Request
POST
/connections
Datatype
Description
Request
body
Expand HTTP Body definition...
body
Connection
Expand DBConnection definition...
can
lock
Operations the current user is able to perform on this object
name
Name of the connection. Also used as the unique identifier
dialect
lock
(Read-only) SQL Dialect details
snippets
pdts_enabled
lock
True if PDTs are enabled on this connection
host
Host name/address of server; or the string 'localhost' in case of a connection over an SSH tunnel.
port
Port number on server. If the connection is over an SSH tunnel, then the local port associated with the SSH tunnel.
username
Username for server authentication
password
(Write-Only) Password for server authentication
uses_oauth
lock
Whether the connection uses OAuth for authentication.
uses_instance_oauth
lock
Whether the integration uses the oauth instance account.
certificate
(Write-Only) Base64 encoded Certificate body for server authentication (when appropriate for dialect).
file_type
(Write-Only) Certificate keyfile type - .json or .p12
database
Database name
db_timezone
Time zone of database
query_timezone
Timezone to use in queries
schema
Schema name
max_connections
Maximum number of concurrent connection to use
max_queries
Maximum number of concurrent queries to begin on this connection
max_queries_per_user
Maximum number of concurrent queries per user to begin on this connection
max_billing_gigabytes
Maximum size of query in GBs (BigQuery only, can be a user_attribute name)
ssl
Use SSL/TLS when connecting to server
verify_ssl
Verify the SSL
tmp_db_name
Name of temporary database (if used)
jdbc_additional_params
Additional params to add to JDBC connection string
pool_timeout
Connection Pool Timeout, in seconds
dialect_name
(Read/Write) SQL Dialect name
supports_data_studio_link
lock
Database connection has the ability to support open data studio from explore
created_at
lock
Creation date for this connection
user_id
lock
Id of user who last modified this connection configuration
example
lock
Is this an example connection?
user_db_credentials
(Limited access feature) Are per user db credentials enabled. Enabling will remove previously set username and password
user_attribute_fields
maintenance_cron
Cron string specifying when maintenance such as PDT trigger checks and drops should be performed
last_regen_at
lock
Unix timestamp at start of last completed PDT trigger check process
last_reap_at
lock
Unix timestamp at start of last completed PDT reap process
sql_runner_precache_tables
Precache tables in the SQL Runner
sql_writing_with_info_schema
Fetch Information Schema For SQL Writing
after_connect_statements
SQL statements (semicolon separated) to issue after connecting to the database. Requires `custom_after_connect_statements` license feature
pdt_context_override
db_connection_override for this connection in the `pdt` maintenance context
managed
lock
Is this connection created and managed by Looker
custom_local_port
This field is only applicable to connections over an SSH Tunnel. The value of this field would be the local port associated with the SSH tunnel if configured manually. Otherwise either enter NULL or exclude this field.
tunnel_id
The Id of the ssh tunnel this connection uses
uses_tns
Enable Transparent Network Substrate (TNS) connections
pdt_concurrency
Maximum number of threads to use to build PDTs in parallel
disable_context_comment
When disable_context_comment is true comment will not be added to SQL
oauth_application_id
An External OAuth Application to use for authenticating to the database
always_retry_failed_builds
When true, error PDTs will be retried every regenerator cycle
uses_application_default_credentials
Whether the connection should authenticate with the Application Default Credentials of the host environment (limited to GCP and certain dialects).
impersonated_service_account
An alternative Service Account to use for querying datasets (used primarily with `uses_application_default_credentials`) (limited to GCP and certain dialects).
cost_estimate_enabled
When true, query cost estimate will be displayed in explore.
pdt_api_control_enabled
PDT builds on this connection can be kicked off and cancelled via API.
connection_pooling
Enable database connection pooling.
default_bq_connection
lock
When true, represents that this connection is the default BQ connection.
bq_storage_project_id
The project id of the default BigQuery storage project.
bq_roles_verified
When true, represents that all project roles have been verified.
p4sa_name
lock
The name of P4SA service account that is associated with the Looker instance
Response
200: Connection
Datatype
Description
(object)
can
lock
Operations the current user is able to perform on this object
name
Name of the connection. Also used as the unique identifier
dialect
lock
(Read-only) SQL Dialect details
Expand Dialect definition...
name
lock
The name of the dialect
label
lock
The human-readable label of the connection
supports_cost_estimate
lock
Whether the dialect supports query cost estimates
cost_estimate_style
lock
How the dialect handles cost estimation
persistent_table_indexes
lock
PDT index columns
persistent_table_sortkeys
lock
PDT sortkey columns
persistent_table_distkey
lock
PDT distkey column
supports_streaming
lock
Supports streaming results
automatically_run_sql_runner_snippets
lock
Should SQL Runner snippets automatically be run
connection_tests
supports_inducer
lock
Is supported with the inducer (i.e. generate from sql)
supports_multiple_databases
lock
Can multiple databases be accessed from a connection using this dialect
supports_persistent_derived_tables
lock
Whether the dialect supports allowing Looker to build persistent derived tables
has_ssl_support
lock
Does the database have client SSL support settable through the JDBC string explicitly?
snippets
Expand Snippet definition...
name
lock
Name of the snippet
label
lock
Label of the snippet
sql
lock
SQL text of the snippet
pdts_enabled
lock
True if PDTs are enabled on this connection
host
Host name/address of server; or the string 'localhost' in case of a connection over an SSH tunnel.
port
Port number on server. If the connection is over an SSH tunnel, then the local port associated with the SSH tunnel.
username
Username for server authentication
password
(Write-Only) Password for server authentication
uses_oauth
lock
Whether the connection uses OAuth for authentication.
uses_instance_oauth
lock
Whether the integration uses the oauth instance account.
certificate
(Write-Only) Base64 encoded Certificate body for server authentication (when appropriate for dialect).
file_type
(Write-Only) Certificate keyfile type - .json or .p12
database
Database name
db_timezone
Time zone of database
query_timezone
Timezone to use in queries
schema
Schema name
max_connections
Maximum number of concurrent connection to use
max_queries
Maximum number of concurrent queries to begin on this connection
max_queries_per_user
Maximum number of concurrent queries per user to begin on this connection
max_billing_gigabytes
Maximum size of query in GBs (BigQuery only, can be a user_attribute name)
ssl
Use SSL/TLS when connecting to server
verify_ssl
Verify the SSL
tmp_db_name
Name of temporary database (if used)
jdbc_additional_params
Additional params to add to JDBC connection string
pool_timeout
Connection Pool Timeout, in seconds
dialect_name
(Read/Write) SQL Dialect name
supports_data_studio_link
lock
Database connection has the ability to support open data studio from explore
created_at
lock
Creation date for this connection
user_id
lock
Id of user who last modified this connection configuration
example
lock
Is this an example connection?
user_db_credentials
(Limited access feature) Are per user db credentials enabled. Enabling will remove previously set username and password
user_attribute_fields
maintenance_cron
Cron string specifying when maintenance such as PDT trigger checks and drops should be performed
last_regen_at
lock
Unix timestamp at start of last completed PDT trigger check process
last_reap_at
lock
Unix timestamp at start of last completed PDT reap process
sql_runner_precache_tables
Precache tables in the SQL Runner
sql_writing_with_info_schema
Fetch Information Schema For SQL Writing
after_connect_statements
SQL statements (semicolon separated) to issue after connecting to the database. Requires `custom_after_connect_statements` license feature
pdt_context_override
db_connection_override for this connection in the `pdt` maintenance context
Expand DBConnectionOverride definition...
context
Context in which to override (`pdt` is the only allowed value)
host
Host name/address of server
port
Port number on server
username
Username for server authentication
password
(Write-Only) Password for server authentication
has_password
lock
Whether or not the password is overridden in this context
certificate
(Write-Only) Base64 encoded Certificate body for server authentication (when appropriate for dialect).
file_type
(Write-Only) Certificate keyfile type - .json or .p12
database
Database name
schema
Schema name
jdbc_additional_params
Additional params to add to JDBC connection string
after_connect_statements
SQL statements (semicolon separated) to issue after connecting to the database. Requires `custom_after_connect_statements` license feature
managed
lock
Is this connection created and managed by Looker
custom_local_port
This field is only applicable to connections over an SSH Tunnel. The value of this field would be the local port associated with the SSH tunnel if configured manually. Otherwise either enter NULL or exclude this field.
tunnel_id
The Id of the ssh tunnel this connection uses
uses_tns
Enable Transparent Network Substrate (TNS) connections
pdt_concurrency
Maximum number of threads to use to build PDTs in parallel
disable_context_comment
When disable_context_comment is true comment will not be added to SQL
oauth_application_id
An External OAuth Application to use for authenticating to the database
always_retry_failed_builds
When true, error PDTs will be retried every regenerator cycle
uses_application_default_credentials
Whether the connection should authenticate with the Application Default Credentials of the host environment (limited to GCP and certain dialects).
impersonated_service_account
An alternative Service Account to use for querying datasets (used primarily with `uses_application_default_credentials`) (limited to GCP and certain dialects).
cost_estimate_enabled
When true, query cost estimate will be displayed in explore.
pdt_api_control_enabled
PDT builds on this connection can be kicked off and cancelled via API.
connection_pooling
Enable database connection pooling.
default_bq_connection
lock
When true, represents that this connection is the default BQ connection.
bq_storage_project_id
The project id of the default BigQuery storage project.
bq_roles_verified
When true, represents that all project roles have been verified.
p4sa_name
lock
The name of P4SA service account that is associated with the Looker instance
400: Bad Request
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
403: Permission Denied
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
409: Resource Already Exists
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
422: Validation Error
Datatype
Description
(object)
message
lock
Error details
errors
Expand ValidationErrorDetail definition...
field
lock
Field with error
code
lock
Error code
message
lock
Error info message
documentation_url
lock
Documentation link
documentation_url
lock
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
Examples
Python
https://github.com/looker-open-source/sdk-codegen/blob/main/examples/python/create_db_connections.py |