MotherDuckDatabaseType
MotherDuck database type options.
MotherDuckDatabaseType
info
MotherDuckDatabaseType is defined beneath the following ancestor nodes in the YAML structure:
Below are the properties for the MotherDuckDatabaseType. Each property links to the specific details section further down in this page.
No properties defined.
Property Details
Connection
Data source/sink Connection.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| connection | One of: S3Connection GcsConnection AbfsConnection LocalFileConnection SnowflakeConnection BigQueryConnection MSSQLConnection MySQLConnection OracleConnection PostgresConnection HttpConnection DuckDBConnection SFTPConnection DatabricksConnection | Yes | Data system Connection. |
DuckDBConnection
Connection to a DuckDB database.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| description | string | No | Brief description of what the model does. | |
| metadata | No | Meta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources. | ||
| name | string | Yes | The name of the model | |
| duckdb | Yes |
DuckDBConnectionOptions
DuckDB Connection options.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| max_query_length | integer | No | Maximum combined query length permitted during query batching. | |
| max_concurrent_queries | integer | No | Maximum number of concurrent queries permitted. | |
| max_combined_sql_statements | integer | No | Maximum number of combined SQL statements permitted during query batching. | |
| path | string | No | Path to the DuckDB database file. Use ':memory:' for in-memory databases. This setting is ignored when DuckLake configuration is present. | |
| memory_limit | integer | No | Memory limit to use for the DuckDB Connection. | |
| ducklake | No | Configuration for using DuckLake with this DuckDB Connection. | ||
| motherduck | No | Configuration for using MotherDuck with this DuckDB Connection. | ||
| schema | string | No | Schema to use for the DuckDB Connection. If left empty, the Flow name will be used as the schema name at runtime | |
| init_sql | string | No | SQL to run when the DuckLake Connection is initialized. |
MotherDuckOptions
MotherDuck configuration options.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| api_key | string | Yes | MotherDuck API token for authentication. Should be a vault reference like $vaults.environment.MOTHERDUCK_API_KEY. | |
| database_name | string | No | Optional MotherDuck database name. If not provided, __ascend_{profile_name} will be used for isolation by Profile. | |
| database_type | MotherDuckDatabaseType | No | Optional database type for MotherDuck. 'native' (default) creates a standard MotherDuck database, 'ducklake' creates a MotherDuck-managed DuckLake database. |