SFTP Connection
Connection to an SFTP server.
SFTPConnection
info
SFTPConnection is defined beneath the following ancestor nodes in the YAML structure:
Below are the properties for the SFTPConnection. 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 | 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. | |
| name | string | Yes | The name of the model | |
| sftp | SFTPConnectionOptions | Yes | The SFTP 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 SynapseConnection SFTPConnection FabricConnection DatabricksConnection | Yes | The connection to the data system. |
SFTPConnectionOptions
SFTP connection options.
| Property | Default | Type | Required | Description |
|---|---|---|---|---|
| host | string | Yes | The SFTP server hostname. | |
| port | 22 | integer | No | The SFTP server port. |
| username | string | Yes | The username for SFTP authentication. | |
| password | string | No | The password for SFTP authentication. | |
| private_key | string | No | The private key string for SFTP authentication. | |
| private_key_passphrase | string | No | The passphrase for the private key, if it's encrypted. | |
| root | / | string | No | The root directory on the SFTP server to use as the base path. |
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. |