# \[V1-V2: deprecated] Table to Storage configuration file The configuration file is in JSON format. It contains the following sections: * Global parameters: General information about the data operation. * Table copy parameters: Optionally, you can add a creation step for a table that will contain the result of the extraction. ## :eye\_in\_speech\_bubble: Example Here is an example of TTS configuration file: ``` { "configuration_type": "table-to-storage", "configuration_id": "tts-some-id-example", "short_description" : "Short description of the job", "environment": "DEV", "account": "000111", "activated": true, "archived": false, "gcs_dest_bucket": "152-composer-test", "gcs_dest_prefix": "jultest_table_to_storage/", "gcp_project": "fd-tailer-datalake", "field_delimiter": "|", "print_header": true, "sql_file": "jul_test.sql", "compression": "None", "output_filename": "{{FD_DATE}}_some_file_name.csv", "copy_table": false, "dest_gcp_project_id": "GCP Project ID used if copy_table is true", "dest_gbq_dataset": "GBQ Dataset used if copy_table is true", "dest_gbq_table": "GBQ Table name used if copy_table is true", "dest_gbq_table_suffix": "dag_execution_date", "delete_dest_bucket_content": true } ``` ## :globe\_with\_meridians: Global parameters General information about the data operation. | Parameter | Description | | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

configuration\_type

type: string

mandatory

|

Type of data operation.

For a TTS data operation, the value is always "table-to-storage".

| |

configuration\_id

type: string

mandatory

|

ID of the data operation.

You can pick any name you want, but is has to be unique for this data operation type.

Note that in case of conflict, the newly deployed data operation will overwrite the previous one. To guarantee its uniqueness, the best practice is to name your data operation by concatenating:

| |

short\_description

type: string

optional

| Short description of the table to storage data operation. | |

environment

type: string

mandatory

|

Deployment context.

Values: PROD, PREPROD, STAGING, DEV.

| |

account

type: string

mandatory

| Your account ID is a 6-digit number assigned to you by your Tailer Platform administrator. | |

activated

type: boolean

optional

|

Flag used to enable/disable the execution of the data operation.

Default value: true

| |

archived

type: boolean

optional

|

Flag used to enable/disable the visibility of the data operation's configuration and runs in Tailer¯Studio.

Default value: false

| |

gcs\_dest\_bucket

type: string

mandatory

|

Google Cloud Storage destination bucket.

This is the bucket where the data is going to be extracted.

| |

gcs\_dest\_prefix

type: string

mandatory

| Path in the GCS bucket where the files will be extracted, e.g. "some/sub/dir". | |

delete\_dest\_bucket\_content

type: boolean

optional

|

If set to true, this parameter will trigger the preliminary deletion of any items present in the destination directory.

This can prevent an issue when a new run of the same operation is needed after a fix. If the first run had generated file-0.csv and file-1.csv, and then the 2nd run only returns and erases file-0.csv, then you need to delete the destination bucket at the begining of the 2nd run, or you will end up with a file-0.csv from the 2nd run and a file-1.csv from the first run.

⚠️ If several table-to-storage operations write in the same directory at the same time, and if this parameter is true, then some extracted files can be deleted by mistake. The best practice is to have a dedicated subdirectory for each operation.

Default value: false

| |

gcp\_project

type: string

mandatory

| ID of the Google Cloud project containing the BigQuery instance. | |

gcp\_project\_id

type: string

optional

| Enter the same value as gcp\_project to avoid the question of project selection during a deployment with tailer deploy configuration command. | |

field\_delimiter

type: string

optional

|

Separator for fields in the CSV output file, e.g. ";".

Note: For Tab separator, set to "\t".

Default value: "

| |

print\_header

type: boolean

optional

|

Print a header row in the exported data.

Default value: true

| |

sql\_file

type: string

mandatory

| Path to the file containing the extraction query. | |

compression

type: string

optional

|

Compression mode for the output file.

Possible values: "None", "GZIP"

Note that if you specify "GZIP", a ".gz" extension will be added at the end of the filename.
Default value: "None"

| |

output\_filename

type: string

mandatory

|

Template for the output filename.

You can use the following placeholders inside the name:

⚠️ BigQuery splits the content in several numbered files if you export more than 1 GB of data. A number starting at 0 and left-padded to 12 digits is added before the extension and after a "-". To ensure a consistent behavior, this number is always added, even if you export less than 1 GB.

For example, an operation with the output\_filename "{{FD\_DATE}}-{{FD\_TIME}}\_my\_data\_extraction.csv" executed the 2022-01-01 on 06:32:16 will generate a file: 20220101-063216\_my\_data\_extraction-000000000000.csv

| |

destination\_format

type: string

optional

|

Define the format of the output file :

Possible values: "NEWLINE\_DELIMITED\_JSON" (JSON file), "AVRO"

Note that if you specify "NEWLINE\_DELIMITED\_JSON", the field-delimiter parameter is not taken into account.
Default value: "CSV"

| ## :two\_men\_holding\_hands: Table copy parameters If you want to create a copy of your output data in a BigQuery table, you need to set the following parameters. | Parameter | Description | | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

copy\_table

type: boolean

optional

|

Parameter used to enable a copy of the output data in a BigQuery table.

Default value: false

| |

dest\_gcp\_project\_id

mandatory if copy\_table is set to "true"

| ID of the GCP project that will contain the table copy. | |

dest\_gbq\_dataset

mandatory if copy\_table is set to "true"

| Name of the BigQuery dataset that will contain the table copy. | |

dest\_gbq\_table

mandatory if copy\_table is set to "true"

| Name of the BigQuery table copy. | |

dest\_gbq\_table\_suffix

optional, to use only if copy\_table is set to "true"

|

The only supported value for this parameter is "dag\_execution\_date".

This will add "\_yyyymmdd" at the end of the table name to enable ingestion time partitioning.

|