Skip to main content
Version: 3.0.0

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.

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
sftpYesThe SFTP 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.

SFTPConnectionOptions​

SFTP connection options.

PropertyDefaultTypeRequiredDescription
hoststringYesThe SFTP server hostname.
port22integerNoThe SFTP server port.
usernamestringYesThe username for SFTP authentication.
passwordstring
NoThe password for SFTP authentication.
private_keystring
NoThe private key string for SFTP authentication.
private_key_passphrasestring
NoThe passphrase for the private key, if it's encrypted.
root/stringNoThe root directory on the SFTP server to use as the base path.
max_concurrent_connectionsinteger
NoThe maximum number of concurrent connections to the SFTP server. If not specified, the default behavior is to use a concurrency value that maximizes download throughput based on the number of CPU cores allocated to the Pod.

ResourceMetadata​

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

PropertyDefaultTypeRequiredDescription
sourceNoThe origin or source information for the resource.
source_event_uuidstring
NoUUID of the event that is associated with creation of this resource.

ResourceLocation​

The origin or source information for the resource.

PropertyDefaultTypeRequiredDescription
pathstringYesPath within repository files where the resource is defined.
first_line_numberinteger
NoFirst line number within path file where the resource is defined.