S3 Reader

All component configurations are classified broadly into 3 section

Please Follow the following steps to configure the metadata:

Ø S3 Reader reads the data from the specified table name

· Steps to configure S3 reader

i) Navigate to the Data Pipeline Editor.

ii) Expand the Reader section provided under the Component Pallet.

iii) Drag and drop the S3 Reader component to the Workflow Editor.

iv) Click on the dragged S3 Reader to get the component properties tabs.

v) Basic Information: It is the default tab to open for the component while configuring it.

a. Invocation Type: Select an invocation mode out of ‘Real-Time’ or ‘Batch’ using the drop-down menu.

b. Deployment Type: It displays the deployment type for the reader component. This field comes pre-selected.

c. Container Image Version: It displays the image version for the docker container. This field comes pre-selected.

d. Failover Event: Select a failover Event from the drop-down menu.

e. Batch Size (min 10): Provide the maximum number of records to be processed in one execution cycle (Min limit for this field is 10).

vi) Open the ‘Meta Information’ tab and fill in all the connection-specific details for the S3 Reader.

· Configuration fields when SNS Monitor is disabled:

i) Bucket Name (*): Folder Name

ii) Zone (*): S3 Zone location

iii) Access Key (*): Access key shared by AWS to login

iv) Secret Key (*): Secret key shared by AWS to login

v) Table (*): Mention the Table or object name which is to be read

vi) File Type (*): Select a file type from the drop-down menu (CSV, JSON, PARQUET, AVRO are the supported file types)

vii) Limit: Set a limit for the number of records.

viii) Query: Insert an SQL query (it supports query containing a join statement as well)

· Configuration fields when SNS Monitor is enabled:

1. Access Key (*): Access key shared by AWS to login

2. Secret Key (*): Secret key shared by AWS to login

3. Table (*): Mention the Table or object name which has to be read

4. File Type (*): Select a file type from the drop-down menu (CSV, JSON, PARQUET, AVRO are the supported file types)

5. Limit: Set limit for the number of records

6. Query: Insert an SQL query (it supports query containing a join statement as well)

vii) Selected Columns: There is also a section for the selected columns in the Meta Information tab if the user can select some specific columns from the table to read data instead of selecting a complete table so this can be achieved by using the ‘Selected Columns’ section. Select the columns which you want to read and if you want to change the name of the column, then put that name in the alias name section otherwise keep the alias name the same as of column name and then select a Column Type from the drop-down menu.

or

Use ‘Download Data’ and ‘Upload File’ options to select the desired columns.

1. Upload File: The user can upload the existing system files (CSV, JSON) using the ‘Upload File’icon (file size must be less than 2 MB).

2. Download Data (Schema): Users can download the schema structure in JSON format by using the ‘Download Data’ icon.

viii) Partition Columns: Provide a unique Key column name to partition data in Spark.

ix) Click the ‘Save Component in Storage’ icon after doing all the configurations to save the reader component.

x) A notification message appears to inform about the component configuration success.

Note:

a. (*) the symbol indicates that the field is mandatory.

b. Either table or query must be specified for the data readers except for SFTP Reader.

c. Selected Columns- There should not be a data type mismatch in the Column Type for all the Reader components.

d. The Meta Information fields may vary based on the selected File Type. All the possibilities are mentioned below:

i. CSV: ‘Header’ and ‘Infer Schema’ fields get displayed with CSV as the selected File Type.

ii. JSON: ‘Multiline’ and ‘Charset’ fields get displayed with JSON as the selected File Type.

iii. PARQUET: No extra field gets displayed with PARQUET as the selected File Type.

iv. AVRO: This File Type provides two drop-down menus.

1. Compression: Select an option out of the ‘Deflate’ and ‘Snappy’ options.

2. Compression Level: This field appears for the Deflate compression option. It provides 0 to 9 levels via a drop-down menu.

Last updated