Package: singer-target-iomete
singer-target-iometeSingertarget that loads data into iomete following
theSinger spec.How to use itIf 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-mvenvvenvpipinstallsinger-target-iometeorpython3-mvenvvenvsource.env/bin/activatepipinstall--upgradepippipinstall.To runLike any other target that's following the singer specification:some-singer-tap | singer-target-iomete --config [config.json]It's reading incoming messages from STDIN and using the properties inconfig.jsonto upload data into iomete.Note: To avoid version conflicts runtapandtargetsin separate virtual environments.Pre-requirementsYou need to create a few objects in iomete in one schema before start using this target.Configuration settingsRunning the the target connector requires aconfig.jsonfile. Example with the minimal settings:{"host":"<cluster_id>.iomete.cloud","workspace_id":"abcde-123","lakehouse":"lakehouse","user":"username","password":"password","database":"default","default_target_schema":"singer","add_metadata_columns":true,"hard_delete":true,"aws_access_key_id":"key_id","aws_secret_access_key":"access_key","s3_bucket":"iom-lakehouse-000000000000","s3_key_prefix":"external/singer/","primary_key_required":false,"no_compression":false,"temp_dir":"../tempdir"}Full list of options inconfig.json:PropertyTypeRequired?DescriptionhostStringYesiomete host (i.e. xyz12.iomete.com)workspace_idStringYesiomete workspace ID (i.e. abcde-123)userStringYesiomete UserpasswordStringYesiomete PasswordlakehouseStringYesiomete lakehouse namedatabaseStringNodatabase (or 'default')aws_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 filesbatch_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 iomete.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 iomete 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 works only with external stages. If no s3_bucket defined with an external stage then flusing tables is enforced to use a single thread.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.schema_mappingObjectUseful if you want to load multiple streams from one tap to multiple iomete schemasadd_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 iomete 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 iomete.hard_deleteBoolean(Default: False) Whenhard_deleteoption is true then DELETE SQL commands will be performed in iomete 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 STRUCT 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 iomete. 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_compression?Boolean(Default: False) Generate uncompressed files when loading to iomete. Normally, by default GZIP compressed files are generated.LicenseApache License Version 2.0SeeLICENSEto see the full text.