Package: oc-pipelinewise-target-snowflake
pipelinewise-target-snowflakeSingertarget that loads data into Snowflake following theSinger spec.This is aPipelineWisecompatible target connector.How to use itThe recommended method of running this target is to use it fromPipelineWise. When running it from PipelineWise you don't need to configure this tap with JSON files and most of things are automated. Please check the related documentation atTarget SnowflakeIf you want to run thisSinger Targetindependently please read further.InstallFirst, make sure Python 3 is installed on your system or follow these
installation instructions forMacorUbuntu.It's recommended to use a virtualenv:python3-mvenvvenvpipinstallpipelinewise-target-snowflakeorpython3-mvenvvenv.venv/bin/activatepipinstall--upgradepippipinstall.Flow diagramTo runLike any other target that's following the singer specificiation:some-singer-tap | target-snowflake --config [config.json]It's reading incoming messages from STDIN and using the properites inconfig.jsonto upload data into Snowflake.Note: To avoid version conflicts runtapandtargetsin separate virtual environments.Pre-requirementsYou need to create a few objects in snowflake in one schema before start using this target.Create a named file format. This will be used by the MERGE/COPY commands to parse the files correctly from S3. You can use CSV or Parquet file formats.To use CSV files:CREATE FILE FORMAT {database}.{schema}.{file_format_name}
TYPE = 'CSV' ESCAPE='\\' FIELD_OPTIONALLY_ENCLOSED_BY='"';To use Parquet files (experimental):CREATE FILE FORMAT {database}.{schema}.{file_format_name} TYPE = 'PARQUET';Important:Parquet files are not supported withtable stages. If you want to use Parquet files then you need to have an external stage in snowflake. Please read further for more details in point 4).Create a Role with all the required permissions:CREATE OR REPLACE ROLE ppw_target_snowflake;
GRANT USAGE ON DATABASE {database} TO ROLE ppw_target_snowflake;
GRANT CREATE SCHEMA ON DATABASE {database} TO ROLE ppw_target_snowflake;

GRANT USAGE ON SCHEMA {database}.{schema} TO role ppw_target_snowflake;
GRANT USAGE ON STAGE {database}.{schema}.{stage_name} TO ROLE ppw_target_snowflake;
GRANT USAGE ON FILE FORMAT {database}.{schema}.{file_format_name} TO ROLE ppw_target_snowflake;
GRANT USAGE ON WAREHOUSE {warehouse} TO ROLE ppw_target_snowflake;Replacedatabase,schema,warehouse,stage_nameandfile_format_namebetween{and}characters to the actual values from point 1 and 2.Create a user and grant permission to the role:CREATE OR REPLACE USER {user}
PASSWORD = '{password}'
DEFAULT_ROLE = ppw_target_snowflake
DEFAULT_WAREHOUSE = '{warehouse}'
MUST_CHANGE_PASSWORD = FALSE;

GRANT ROLE ppw_target_snowflake TO USER {user};Replacewarehousebetween{and}characters to the actual values from point 3.Optional external stage:By defaulttable stagesare used to load data into snowflake tables. If you want to use external stages with s3 or s3 compatible storage engines then you need to create a STAGE object:CREATE STAGE {database}.{schema}.{stage_name}
url='s3://{s3_bucket}'
credentials=(AWS_KEY_ID='{aws_key_id}' AWS_SECRET_KEY='{aws_secret_key}')
encryption=(MASTER_KEY='{client_side_encryption_master_key}');
GRANT USAGE ON STAGE {database}.{schema}.{stage_name} TO ROLE ppw_target_snowflake;Notes:To use external stages you need to defines3_bucketandstagevalues inconfig.jsonas well.Theencryptionoption is optional and used for client side encryption.If you want client side encryption enabled you need to define the same master key in the targetconfig.json.Instead ofcredentialsyou can also usestorage_integrationFurther details below in the Configuration settings section.Configuration settingsRunning the the target connector requires aconfig.jsonfile. Example with the minimal settings:{"account":"rtxxxxx.eu-central-1","dbname":"database_name","user":"my_user","password":"password","warehouse":"my_virtual_warehouse","file_format":"snowflake_file_format_object_name","default_target_schema":"my_target_schema"}Full list of options inconfig.json:PropertyTypeRequired?DescriptionaccountStringYesSnowflake account name (i.e. rtXXXXX.eu-central-1)dbnameStringYesSnowflake Database nameuserStringYesSnowflake UserpasswordStringYesSnowflake PasswordwarehouseStringYesSnowflake virtual warehouse nameroleStringNoSnowflake role to use. If not defined then the user's default role will be usedaws_access_key_idStringNoS3 Access Key Id. If not provided,AWS_ACCESS_KEY_IDenvironment variable or IAM role will be usedaws_secret_access_keyStringNoS3 Secret Access Key. If not provided,AWS_SECRET_ACCESS_KEYenvironment variable or IAM role will be usedaws_session_tokenStringNoAWS Session token. If not provided,AWS_SESSION_TOKENenvironment variable will be usedaws_profileStringNoAWS profile name for profile based authentication. If not provided,AWS_PROFILEenvironment variable will be used.s3_bucketStringNoS3 Bucket name. Required if to use S3 External stage. When this is defined thenstagehas to be defined as well.s3_key_prefixStringNo(Default: None) A static prefix before the generated S3 key names. Using prefixes you can upload files into specific directories in the S3 bucket.s3_endpoint_urlStringNoThe complete URL to use for the constructed client. This is allowing to use non-native s3 account.s3_region_nameStringNoDefault region when creating new connectionss3_aclStringNoS3 ACL name to set on the uploaded filesstageStringNoNamed external stage name created at pre-requirements section. Has to be a fully qualified name including the schema name. If not specified, table internal stage are used. When this is defined thens3_buckethas to be defined as well.file_formatStringYesNamed file format name created at pre-requirements section. Has to be a fully qualified name including the schema name.batch_size_rowsInteger(Default: 100000) Maximum number of rows in each batch. At the end of each batch, the rows in the batch are loaded into Snowflake.batch_wait_limit_secondsInteger(Default: None) Maximum time to wait for batch to reachbatch_size_rows.flush_all_streamsBoolean(Default: False) Flush and load every stream into Snowflake when one batch is full. Warning: This may trigger the COPY command to use files with low number of records, and may cause performance problems.parallelismInteger(Default: 0) The number of threads used to flush tables. 0 will create a thread for each stream, up to parallelism_max. -1 will create a thread for each CPU core. Any other positive number will create that number of threads, up to parallelism_max.parallelism_maxInteger(Default: 16) Max number of parallel threads to use when flushing tables.default_target_schemaStringName of the schema where the tables will be created,withoutdatabase prefix. Ifschema_mappingis not defined then every stream sent by the tap is loaded into this schema.default_target_schema_select_permissionStringGrant USAGE privilege on newly created schemas and grant SELECT privilege on newly created tables to a specific role or a list of roles. Ifschema_mappingis not defined then every stream sent by the tap is granted accordingly.schema_mappingObjectUseful if you want to load multiple streams from one tap to multiple Snowflake schemas.If the tap sends thestream_idin<schema_name>-<table_name>format then this option overwrites thedefault_target_schemavalue. Note, that usingschema_mappingyou can overwrite thedefault_target_schema_select_permissionvalue to grant SELECT permissions to different groups per schemas or optionally you can create indices automatically for the replicated tables.Note: This is an experimental feature and recommended to use via PipelineWise YAML files that will generate the object mapping in the right JSON format. For further info check a [PipelineWise YAML Example]disable_table_cacheBoolean(Default: False) By default the connector caches the available table structures in Snowflake at startup. In this way it doesn't need to run additional queries when ingesting data to check if altering the target tables is required. Withdisable_table_cacheoption you can turn off this caching. You will always see the most recent table structures but will cause an extra query runtime.client_side_encryption_master_keyString(Default: None) When this is defined, Client-Side Encryption is enabled. The data in S3 will be encrypted, No third parties, including Amazon AWS and any ISPs, can see data in the clear. Snowflake COPY command will decrypt the data once it's in Snowflake. The master key must be 256-bit length and must be encoded as base64 string.add_metadata_columnsBoolean(Default: False) Metadata columns add extra row level information about data ingestions, (i.e. when was the row read in source, when was inserted or deleted in snowflake etc.) Metadata columns are creating automatically by adding extra columns to the tables with a column prefix_SDC_. The column names are following the stitch naming conventions documented athttps://www.stitchdata.com/docs/data-structure/integration-schemas#sdc-columns. Enabling metadata columns will flag the deleted rows by setting the_SDC_DELETED_ATmetadata column. Without theadd_metadata_columnsoption the deleted rows from singer taps will not be recongisable in Snowflake.hard_deleteBoolean(Default: False) Whenhard_deleteoption is true then DELETE SQL commands will be performed in Snowflake to delete rows in tables. It's achieved by continuously checking the_SDC_DELETED_ATmetadata column sent by the singer tap. Due to deleting rows requires metadata columns,hard_deleteoption automatically enables theadd_metadata_columnsoption as well.data_flattening_max_levelInteger(Default: 0) Object type RECORD items from taps can be loaded into VARIANT columns as JSON (default) or we can flatten the schema by creating columns automatically.When value is 0 (default) then flattening functionality is turned off.primary_key_requiredBoolean(Default: True) Log based and Incremental replications on tables with no Primary Key cause duplicates when merging UPDATE events. When set to true, stop loading data if no Primary Key is defined.validate_recordsBoolean(Default: False) Validate every single record message to the corresponding JSON schema. This option is disabled by default and invalid RECORD messages will fail only at load time by Snowflake. Enabling this option will detect invalid records earlier but could cause performance degradation.temp_dirString(Default: platform-dependent) Directory of temporary files with RECORD messages.no_compressionBoolean(Default: False) Generate uncompressed files when loading to Snowflake. Normally, by default GZIP compressed files are generated.query_tagString(Default: None) Optional string to tag executed queries in Snowflake. Replaces tokens{{database}},{{schema}}and{{table}}with the appropriate values. The tags are displayed in the output of the SnowflakeQUERY_HISTORY,QUERY_HISTORY_BY_*functions.archive_load_filesBoolean(Default: False) When enabled, the files loaded to Snowflake will also be stored inarchive_load_files_s3_bucketunder the key/{archive_load_files_s3_prefix}/{schema_name}/{table_name}/. All archived files will havetap,schema,tableandarchived-byas S3 metadata keys. When incremental replication is used, the archived files will also have the following S3 metadata keys:incremental-key,incremental-key-minandincremental-key-max.archive_load_files_s3_prefixString(Default: "archive") Whenarchive_load_filesis enabled, the archived files will be placed in the archive S3 bucket under this prefix.archive_load_files_s3_bucketString(Default: Value ofs3_bucket) Whenarchive_load_filesis enabled, the archived files will be placed in this bucket.To run tests:Define the environment variables that are required to run the tests by creating a.envfile intests/integration, or by exporting the variables below.export TARGET_SNOWFLAKE_ACCOUNT=<snowflake-account-name>
  export TARGET_SNOWFLAKE_DBNAME=<snowflake-database-name>
  export TARGET_SNOWFLAKE_USER=<snowflake-user>
  export TARGET_SNOWFLAKE_PASSWORD=<snowflake-password>
  export TARGET_SNOWFLAKE_WAREHOUSE=<snowflake-warehouse>
  export TARGET_SNOWFLAKE_SCHEMA=<snowflake-schema>
  export TARGET_SNOWFLAKE_AWS_ACCESS_KEY=<aws-access-key-id>
  export TARGET_SNOWFLAKE_AWS_SECRET_ACCESS_KEY=<aws-access-secret-access-key>
  export TARGET_SNOWFLAKE_S3_ACL=<s3-target-acl>
  export TARGET_SNOWFLAKE_S3_BUCKET=<s3-external-bucket>
  export TARGET_SNOWFLAKE_S3_KEY_PREFIX=<bucket-directory>
  export TARGET_SNOWFLAKE_STAGE=<stage-object-with-schema-name>
  export TARGET_SNOWFLAKE_FILE_FORMAT_CSV=<file-format-csv-object-with-schema-name>
  export TARGET_SNOWFLAKE_FILE_FORMAT_PARQUET=<file-format-parquet-object-with-schema-name>
  export CLIENT_SIDE_ENCRYPTION_MASTER_KEY=<client_side_encryption_master_key>Install python test dependencies in a virtual env and run unit and integration testspython3 -m venv venv
  . venv/bin/activate
  pip install --upgrade pip
  pip install .[test]To run unit tests:pytest tests/unitTo run integration tests:pytest tests/integrationTo run pylint:Install python dependencies and run python linterpython3 -m venv venv
  . venv/bin/activate
  pip install --upgrade pip
  pip install .[test]
  pylint target_snowflakeLicenseApache License Version 2.0SeeLICENSEto see the full text.