DuckDB Connection

Connection to a DuckDB database.

Examples

duckdb_connection_simple.yaml

connection:
  duckdb:
    path: /path/to/your/duckdb/file

duckdb_connection_multiuser.yaml

connection:
  name: UniqueDuckDBConnection
  description: DuckDB connection optimized for multi-user environments with up to 10 concurrent queries.
  duckdb:
    max_concurrent_queries: 10
    path: /path/to/your/duckdb/database/file.duckdb

duckdb_high_performance.yaml

connection:
  name: HighPerformanceDuckDBConnection
  description: DuckDB connection configured for high-performance with specific limits.
  duckdb:
    path: /path/to/your/duckdb/database/file.duckdb
    memory_limit: 2048
    max_query_length: 10000
    max_concurrent_queries: 5

DuckDBConnection

info

DuckDBConnection is defined beneath the following ancestor nodes in the YAML structure:

• Connection

Below are the properties for the DuckDBConnection. Each property links to the specific details section further down in this page.

Property	Default	Type	Required	Description
name		string	No	The name of the model
description		string	No	A brief description of what the model does.
metadata		ResourceMetadata	No	Meta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.
duckdb		DuckDBConnectionOptions	Yes	The DuckDB connection options.

Property Details

Connection

A connection to a data source/sink.

Property	Default	Type	Required	Description
connection		One of:   S3Connection   GcsConnection   AbfsConnection   LocalFileConnection   SnowflakeConnection   BigQueryConnection   MSSQLConnection   MySQLConnection   OracleConnection   PostgresConnection   HttpConnection   DuckDBConnection   CustomPythonConnection   SynapseConnection	Yes	The connection to the data system.

DuckDBConnectionOptions

DuckDB connection options.

Property	Default	Type	Required	Description
max_query_length		integer	No	The maximum query length to allow.
max_concurrent_queries		integer	No	The maximum number of concurrent queries to allow.
max_combined_sql_statements		integer	No	The maximum number of combined SQL statements to allow.
path		string	Yes	The path to the DuckDB database file.
memory_limit		integer	No	The memory limit to use for the DuckDB connection.

ResourceMetadata

Meta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.

Property	Default	Type	Required	Description
source		ResourceLocation	No	The origin or source information for the resource.
source_event_uuid		string	No	UUID of the event that is associated with creation of this resource.

ResourceLocation

The origin or source information for the resource.

Property	Default	Type	Required	Description
path		string	Yes	Path within repository files where the resource is defined.
first_line_number		integer	No	First line number within path file where the resource is defined.