Local File Connection

Local file system Connection.

Examples

complex_localfileconnection_example.yaml

connection:
  local_file:
    root: /specific/root/directory

localfileconnection_config.yaml

connection:
  local_file:
    root: /path/to/local/directory

localfileconnection_setup.yaml

connection:
  local_file:
    root: /path/to/your/root/directory

LocalFileConnection

info

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

• Connection

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

Property	Default	Type	Required	Description
description		string	No	A 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
local_file			Yes	Local File Connection options.

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.

LocalFileConnectionOptions

Local file Connection options.

Property	Default	Type	Required	Description
root		string	Yes	Root directory for the Local File 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			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.