Prerequisites

To complete this Quickstart, your environment must meet the following prerequisites:

• AWS Account: This Quickstart uses Amazon S3 and requires an AWS account’s access key id and secret access key.

• SingleStore Helios installation –or– a SingleStore Helios workspace: You will connect to the database or workspace and create a pipeline to pull data from your Amazon S3 bucket.

Part 1: Creating an Amazon S3 Bucket and Adding a File

1. On your local machine, create a text file with the following CSV contents and name it books.txt:

   Copy

   The Catcher in the Rye, J.D. Salinger, 1945
   Pride and Prejudice, Jane Austen, 1813
   Of Mice and Men, John Steinbeck, 1937
   Frankenstein, Mary Shelley, 1818

2. In S3 create a bucket and upload books.txt to the bucket. For information on working with S3, refer to the Amazon S3 documentation.

   Note that the aws_access_key_id that your SingleStore pipeline will use (specified in the next section in CREATE PIPELINE library ... CREDENTIALS ...) must have read access to both the bucket and the file.

Once the books.txt file has been uploaded, you can proceed to the next part of the Quickstart.

Part 2: Generating AWS Credentials

To be able to use an S3 bucket within the pipeline syntax, the following minimum permissions are required:

• s3:GetObject

• s3:ListBucket

These permissions only provide for read access from an S3 bucket which is the minimum required to ingest data into a pipeline.

There are two ways to create an IAM Policy: with the Visual editor or JSON. Both creation methods require obtaining the Amazon Resource Number (ARN) before the policy is created.

Part 3: Creating a SingleStore Database and S3 Pipeline

Now that you have an S3 bucket that contains an object (file), you can use SingleStore Helios or DB to create a new pipeline and ingest the messages.

Create a new database and a table that adheres to the schema contained in the books.txt file. At the prompt, execute the following statements:

CREATE DATABASE books;

CREATE TABLE classic_books
(
title VARCHAR(255),
author VARCHAR(255),
date VARCHAR(255)
);

These statements create a new database named books and a new table named classic_books, which has three columns: title, author, and date.

Now that the destination database and table have been created, you can create an S3 pipeline. In Part 1 of this Quickstart, you uploaded the books.txt file to your bucket. To create the pipeline, you will need the following information:

• The name of the bucket, such as: <bucket-name>

• The name of the bucket’s region, such as: us-west-1

• Your AWS account’s access keys, such as:

  • Access Key ID: <aws_access_key_id>

  • Secret Access Key: <aws_secret_access_key>

• Your AWS account's session token, such as:

  • Session Token: your_session_token

  • Note that the aws_session_token is required only if your credentials in the CREDENTIALS clause are temporary

Using these identifiers and keys, execute the following statement, replacing the placeholder values with your own.

CREATE PIPELINE library
AS LOAD DATA S3 'my-bucket-name'
CONFIG '{"region": "us-west-1"}'
CREDENTIALS '{"aws_access_key_id": "your_access_key_id", "aws_secret_access_key": "your_secret_access_key", "aws_session_token": "your_session_token"}'
INTO TABLE `classic_books`
FIELDS TERMINATED BY ',';

You can see what files the pipeline wants to load by running the following:

SELECT * FROM information_schema.PIPELINES_FILES;

If everything is properly configured, you should see one row in the Unloaded state, corresponding to books.txt. The CREATE PIPELINE statement creates a new pipeline named library, but the pipeline has not yet been started, and no data has been loaded. A SingleStore pipeline can run either in the background or be triggered by a foreground query. Start it in the foreground first.

START PIPELINE library FOREGROUND;

When this command returns success, all files from your bucket will be loaded. If you check information_schema.PIPELINES_FILES again, you should see all files in the Loaded state. Now query the classic_books table to make sure the data has actually loaded.

SELECT * FROM classic_books;

+------------------------+-----------------+-------+
| title                  | author          | date  |
+------------------------+-----------------+-------+
| The Catcher in the Rye |  J.D. Salinger  |  1945 |
| Pride and Prejudice    |  Jane Austen    |  1813 |
| Of Mice and Men        |  John Steinbeck |  1937 |
| Frankenstein           |  Mary Shelley   |  1818 |
+------------------------+-----------------+-------+

You can also have SingleStore run your pipeline in the background. In such a configuration, SingleStore will periodically poll S3 for new files and continuously them as they are added to the bucket. Before running your pipeline in the background, you must reset the state of the pipeline and the table.

DELETE FROM classic_books;
ALTER PIPELINE library SET OFFSETS EARLIEST;

The first command deletes all rows from the target table. The second causes the pipeline to start from the beginning, in this case, forgetting it already loaded books.txt so you can load it again. You can also drop and recreate the pipeline, if you prefer.

To start a pipeline in the background, run

START PIPELINE library;

This statement starts the pipeline. To see whether the pipeline is running, run SHOW PIPELINES.

SHOW PIPELINES;

+----------------------+---------+
| Pipelines_in_books   | State   |
+----------------------+---------+
| library              | Running |
+----------------------+---------+

At this point, the pipeline is running and the contents of the books.txt file should once again be present in the classic_books table.

Use Cloud Workload Identity with S3 Pipelines

You can use Cloud Workload Identity instead of static credentials to load data via S3 pipelines.

Perform the following tasks to create an S3 pipeline that authenticates using the cloud workload identity:

1. Configure delegated entities.

   1. Create an IAM role in your AWS account with the necessary privileges. You can also use an existing IAM role.

   2. Update the IAM role's trust policy to allow the workspace's cloud workload identity to assume the role. Specify the cloud workload identity ARN of the SingleStore workspace.

   Alternatively, create a CloudFormation stack to configure the IAM roles.

2. Create an S3 pipeline. In the pipeline configuration:

   1. Set creds_mode to eks_irsa in the CONFIG clause.

   2. Specify the IAM role to assume using role_arn in the CREDENTIALS clause. The specified role ARN must match the configured delegated entities for the SingleStore workspace. For example:

      SQL

      Copy

      CREATE PIPELINE s3_pipeline AS
      LOAD DATA S3 's3://bucket-name/path/'
      CONFIG '{
        "region": "us-east-1",
        "creds_mode": "eks_irsa"
      }'
      CREDENTIALS '{
        "role_arn": "arn:aws:iam::xxxxxxxx:role/singlestore-s3-pipeline"
      }'
      INTO TABLE table_name
      FIELDS TERMINATED BY ',';

3. Start the pipeline to ingest data.

   SQL

   Copy

   START PIPELINE s3_pipeline;

If delegated entities are not configured, SingleStore pipelines that attempt to use IRSA with a role ARN not present in the delegated entities list fail at runtime.

Next Steps

See About SingleStore Pipelines to learn more about how pipelines work.