Skip to content

Latest commit

 

History

History
26 lines (24 loc) · 5.11 KB

DatabaseRestApiPut.md

File metadata and controls

26 lines (24 loc) · 5.11 KB
Raw

SwaggerClient::DatabaseRestApiPut

Properties

Name Type Description Notes
allow_ctas BOOLEAN Allow CREATE TABLE AS option in SQL Lab [optional]
allow_cvas BOOLEAN Allow CREATE VIEW AS option in SQL Lab [optional]
allow_dml BOOLEAN Allow users to run non-SELECT statements (UPDATE, DELETE, CREATE, ...) in SQL Lab [optional]
allow_file_upload BOOLEAN Allow to upload CSV file data into this databaseIf selected, please set the schemas allowed for csv upload in Extra. [optional]
allow_multi_schema_metadata_fetch BOOLEAN Allow SQL Lab to fetch a list of all tables and all views across all database schemas. For large data warehouse with thousands of tables, this can be expensive and put strain on the system. [optional]
allow_run_async BOOLEAN Operate the database in asynchronous mode, meaning that the queries are executed on remote workers as opposed to on the web server itself. This assumes that you have a Celery worker setup as well as a results backend. Refer to the installation docs for more information. [optional]
cache_timeout Integer Duration (in seconds) of the caching timeout for charts of this database. A timeout of 0 indicates that the cache never expires. Note this defaults to the global timeout if undefined. [optional]
configuration_method **** Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri. [optional]
database_name String A database name to identify this connection. [optional]
encrypted_extra String <p>JSON string containing additional connection configuration.<br>This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.</p> [optional]
engine String SQLAlchemy engine to use [optional]
expose_in_sqllab BOOLEAN Expose this database to SQLLab [optional]
external_url String [optional]
extra String <p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=&quot;https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\&quot;&gt;sqlalchemy.create_engine&lt;/a> call, while the <code>metadata_params</code> gets unpacked into the <a href=&quot;https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\&quot;&gt;sqlalchemy.MetaData&lt;/a> call.<br>2. The <code>metadata_cache_timeout</code> is a cache timeout setting in seconds for metadata fetch of this database. Specify it as <strong>&quot;metadata_cache_timeout&quot;: {&quot;schema_cache_timeout&quot;: 600, &quot;table_cache_timeout&quot;: 600}</strong>. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.<br>3. The <code>schemas_allowed_for_file_upload</code> is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as <strong>&quot;schemas_allowed_for_file_upload&quot;: [&quot;public&quot;, &quot;csv_upload&quot;]</strong>. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty<br>4. The <code>version</code> field is a string specifying the this db's version. This should be used with Presto DBs so that the syntax is correct<br>5. The <code>allows_virtual_table_explore</code> field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.<br>6. The <code>disable_data_preview</code> field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.</p> [optional]
force_ctas_schema String When allowing CREATE TABLE AS option in SQL Lab, this option forces the table to be created in this schema [optional]
impersonate_user BOOLEAN If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.<br/>If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property. [optional]
is_managed_externally BOOLEAN [optional]
parameters Hash<String, null> DB-specific parameters for configuration [optional]
server_cert String <p>Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.</p> [optional]
sqlalchemy_uri String <p>Refer to the <a href=&quot;https://docs.sqlalchemy.org/en/rel_1_2/core/engines.html#database-urls\&quot;&gt;SqlAlchemy docs</a> for more information on how to structure your URI.</p> [optional]