Skip to main content
Version: 3.0.0

Local File Connection

InlineLocalFileConnection

info

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

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

PropertyDefaultTypeRequiredDescription
local_fileYesThe local file connection options.

Property Details

Connection

A connection to a data source/sink.

PropertyDefaultTypeRequiredDescription
connectionOne of:
  S3Connection
  GcsConnection
  AbfsConnection
  LocalFileConnection
  SnowflakeConnection
  BigQueryConnection
  MSSQLConnection
  MySQLConnection
  OracleConnection
  PostgresConnection
  HttpConnection
  DuckDBConnection
  SFTPConnection
  DatabricksConnection
YesThe connection to the data system.

DuckDBConnection

Connection to a DuckDB database.

PropertyDefaultTypeRequiredDescription
descriptionstring
NoA brief description of what the model does.
metadataNoMeta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.
namestringYesThe name of the model
duckdbYesThe DuckDB connection options.

DuckDBConnectionOptions

DuckDB connection options.

PropertyDefaultTypeRequiredDescription
max_query_lengthinteger
NoThe maximum query length to allow.
max_concurrent_queriesinteger
NoThe maximum number of concurrent queries to allow.
max_combined_sql_statementsinteger
NoThe maximum number of combined SQL statements to allow.
pathstring
NoThe path to the DuckDB database file. Use ':memory:' for in-memory databases. This setting is ignored when ducklake configuration is present.
memory_limitinteger
NoThe memory limit to use for the DuckDB connection.
ducklakeNoConfiguration for using DuckLake with this DuckDB connection.
schemastringNoThe schema to use for the DuckDB connection. If left empty, the flow name will be used as the schema name at runtime

DuckLakeOptions

DuckLake configuration options.

PropertyDefaultTypeRequiredDescription
metadata_connection_namestring
NoThe name of the Ascend Connection to use for DuckLake metadata storage (Postgres connections only).
data_connection_namestring
NoThe name of the Ascend Connection to use for DuckLake data storage (Local Files, GCS, S3, or ABFS connections supported).
metadata_connectionAny of:
  InlinePostgresConnection
  ASCEND_MANAGED
NoInline metadata connection configuration (Postgres connections only).
data_connectionAny of:
  One of:
    InlineLocalFileConnection
    InlineS3Connection
    InlineGcsConnection
    InlineAbfsConnection
  ASCEND_MANAGED
NoInline data connection configuration (Local Files, GCS, S3, or ABFS connections supported).
metadata_schemadefaultstringNoThe schema name within the Postgres database to use for DuckLake metadata storage. If left as the default value of 'default', the schema name will be replaced with the profile name at runtime.
data_pathascendlake/datastringNoPath within the data connection root where DuckLake data files will be stored.

LocalFileConnectionOptions

Local file connection options.

PropertyDefaultTypeRequiredDescription
rootstringYesThe root directory for the local file connection.