Skip to main content

bit.io - Upload File to Table from Shipyard

Overview​

Upload one or more CSV files to any table in bit.io. With the file data, you can:

  • Append Data - Add the contents of your file to the end of the table.
  • Replace Data - Write over the entire contents of table with the contents of your file.
  • Add Data Only if Table is Empty - Add data to the table if no data exists.

Column names are inferred from the header row of your CSV file. Column names must not be null or be duplicate values.

If the table already exists, the header values are matched to the table column names. The header names must match the existing column names in your table, otherwise the Vessel will error.

Data is inserted into the table by using multiple INSERT statements.

In all instances, if the table name does not already exist, a new table will be created with datatypes inferred from the CSV contents.

Note: This Vessel cannot be used to upload a local file from your computer.

Recommended Setup:

  1. A Vessel built with this Blueprint should typically run after a Vessel that either downloads a file to Shipyard or generates a file with code.

Variables​

NameReferenceTypeRequiredDefaultOptionsDescription
PasswordBITIO_PASSWORDPasswordβœ…--Password associated to your bit.io account. For more information, see the Authorization documentation.
DatabaseBITIO_DATABASEAlphanumericβœ…--Name of the database to connect to. This is the same as your current repository name, which has the structure user_name/repo_name.
Shipyard Folder NameBITIO_SOURCE_FOLDER_NAMEAlphanumericβž–--Folder where the file to upload can be found. If left blank, will search in the current working directory.
Shipyard File Name Match TypeBITIO_SOURCE_FILE_NAME_MATCH_TYPESelectβœ…exact_matchExact Match: exact_match

Regex Match: regex_match

Determines if the text in "File Name" will match exactly to a single file, or use regex to match to multiple files.
Shipyard File NameBITIO_SOURCE_FILE_NAMEAlphanumericβœ…--The file name that contains the data you want uploaded.
SchemaBITIO_SCHEMAAlphanumericβž–--Schema where the table you're creating or uploading to exists.
Table NameBITIO_TABLE_NAMEAlphanumericβœ…--Name of the table where you want data inserted. If the table doesn't already exist, it will be created.
Insertion MethodBITIO_INSERT_METHODSelectβœ…appendAppend Data: append

Replace Data: replace

Add Data Only if Table is Empty: fail

Determines how the data in your file will be added into the target table.

YAML​

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
blueprint: bit.io - Upload File to Table from Shipyard
inputs:
BITIO_PASSWORD: null ## REQUIRED
BITIO_DATABASE: null ## REQUIRED
BITIO_SOURCE_FOLDER_NAME: null
BITIO_SOURCE_FILE_NAME_MATCH_TYPE: exact_match ## REQUIRED
BITIO_SOURCE_FILE_NAME: null ## REQUIRED
BITIO_SCHEMA: null
BITIO_TABLE_NAME: null ## REQUIRED
BITIO_INSERT_METHOD: append ## REQUIRED
type: BLUEPRINT
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- '0'