Sign inTry Free

Important

The SingleStore 9.0 release candidate (RC) gives you the opportunity to preview, evaluate, and provide feedback on new and upcoming features prior to their general availability. In the interim, SingleStore 8.9 is recommended for production workloads, which can later be upgraded to SingleStore 9.0.

Settings

On this page

Instance Details

Navigate to Settings > Instance Details, and enter the following configuration details:

  1. Ingest Instance Name: Enter a name for the current instance of Ingest.

  2. Web Port: Enter the port on which the Ingest server runs.

  3. Icon Text: Enter the text for your instance icon. The text takes only 2 characters.

  4. Icon Color: Select the color for your instance icon.

Select Apply to save the settings.

History

Navigate to Settings > History, and enter the following configuration details:

  1. Enable Keep history by default, if you want to keep history always.

  2. In History Start Date Column, enter the source date for type-2 SCD records.

  3. In History End Date Column, enter the history end date for type-2 SCD records.

  4. In Open End Date Column (YYYY-MM-DD), enter the end date used for history records.

  5. In Max. Updates in batch, enter the value that determines when combined updates exceed this threshold in a batch.

Select Apply to save the settings.

About Ingest

To view the Version, Build, Host Name, and Ingest Location of your installed Ingest Instance, navigate to Settings > About Ingest.

User-Defined Settings

To add custom fields, navigate to Settings > User Defined Settings. Enter the Name and Value of your custom field, and select the Save icon. You can also Delete and Undo the name and value of your custom field.

Note: You can add only one custom field.

Preserve source table and column names at the destination

If table or column names use reserved SQL keywords, Flow automatically appends an underscore (e.g., role becomes role_) to avoid conflicts.

To preserve the table and column names exactly as they are defined in the source schema, follow these steps:

  1. Navigate to Settings > User Defined Settings.

  2. Set Name to keep_res.

  3. Set Value to Y.

  4. Select the Save icon.

  5. Restart the Ingest service.

Email Notification

To configure email updates, navigate to Settings > Email Notification, and then perform the following steps:

  1. To receive email notifications, enable Enable Email Notifications.

  2. In Host Name, enter the address of your SMTP server.

  3. In Port, enter the port number that the SMTP server is listening on.

  4. In Sender, enter the email address from which the notifications are sent. This must be a valid email address on the server.

  5. In Recipient, enter the email address to which the notifications are sent.

  6. In User ID, enter the full email address to authenticate with the SMTP server.

  7. Enter the Password for the email, then confirm it in the Confirm Password field.

    Note: Passwords are encrypted within Ingest.

Select Apply to save the settings.

AWS Proxy Settings

Navigate to Settings > AWS Proxy Settings, enter the following configuration details.

  1. Proxy Host: Enter the S3 proxy host name.

  2. Proxy Port: Enter the S3 proxy port.

  3. Proxy User Id: Enter the S3 proxy user ID.

  4. Proxy Password: Enter the S3 proxy password.

Select Apply to save the settings.

AWS Credentials

Ingest can access AWS services using either IAM roles or access keys when deployed on-premises. You must configure the access method and credentials in Ingest.

To access AWS services from an on-premises SingleStore Flow server, navigate to Settings > AWS Credentials, and perform the following steps.

  1. Enable Use EC2 IAM Role, if you are using.

  2. Select the AWS Region from the list.

  3. Enter the AWS access key ID in AWS Key and AWS Secret Key to access the S3 service (if installed on-premises). For installations using IAM roles, these keys are not required. Note: Keys are encrypted within Ingest.

  4. If you are using KMS, enter the KMS Key in AWS Key. Note: Keys are encrypted within Ingest.

Select Apply to confirm and save the details.

AWS CloudWatch Logs

Ingest comes pre-configured with remote monitoring capabilities that leverage existing AWS technologies, such as CloudWatch Logs and Events. CloudWatch, along with other AWS services, can monitor the execution of Ingest and trigger appropriate alarms in case of errors or failures. The events from Ingest application flows to CloudWatch Logs. These events provide detailed application statistics that can be used for custom monitoring.

In addition to integration with CloudWatch, Ingest writes internal logs directly to S3, including execution and error logs from the Ingest console. Navigate to Settings > AWS CloudWatch Logs, and perform the following steps.

  1. Check Enable CloudWatch Logs and metrics to get notified. AWS CloudWatch events can be used for alerting by writing custom Lambda functions.

  2. Enter the name of the CloudWatch Log Group. This needs to be created first in the AWS console.To create a CloudWatch Log Group, refer to CreateLogGroup for more information.

  3. Enter the name of the CloudWatch Log Stream. This also needs to be created first in the AWS console. To create a CloudWatch Log Stream, refer to CreateLogStream for more information.

  4. Select Apply to save the settings.

Refer to Appendix for more information.

AWS CloudWatch Metrics

Navigate to Settings AWS CloudWatch Metrics, and perform the following steps.

  1. Check Enable CloudWatch Metrics if required.

  2. In CloudWatch Metrics Namespace, enter the name of CloudWatch metric. Refer to View available metrics for more information.

  3. Select Apply to save the settings.

The events that Ingest pushes to AWS CloudWatch Logs and the metrics console are as follows. Refer to Appendix and Appendix for more information.

AWS SNS Notifications

Navigate to Settings > AWS SNS Notifications, and perform the following steps.

  1. Check Enable SNS notifications and subscribe to the SNS topic via the AWS console.

  2. In SNS Topic, enter the Topic ARN or SNS Topic Name. To create an SNS Topic, refer to Creating an Amazon SNS Topic for more information.

  3. Select Apply to save the settings.

Refer to Appendix for more information.

AWS S3 Logging

Navigate to Settings > AWS S3 Logging, and perform the following steps.

  1. Check Enable S3 Logging if you want to record data to S3 (console/execution logs).

  2. In S3 Log Location, enter the destination of the logging data in S3, for example: s3://your_bucket_name/your_folder_name.

  3. In S3 KMS Id, enter the KMS ID to encrypt logs in S3. This is optional but recommended. When provided, logs are encrypted using KMS encryption.

  4. Select Apply to save the settings.

Metadata Settings

Navigate to Settings > Metadata Settings, and perform the following steps.

  1. Check Enable Operational Metadata, if required.

  2. Select metadata database from the Database Type list: AWS Aurora.

  3. In Host Name, enter the IP address or hostname of the database server.

  4. In Port, enter the port number on which the database server is listening.

  5. In Database Name, enter the name of your database.

  6. In Database Schema, enter the schema name of your database.

  7. In User Id, enter a valid database user ID to be used with Ingest.

  8. Enter the Password and confirm it by re-entering it in the Confirm Password field.

  9. JDBC Options are optional and can be used to extend the JDBC URL for accessing the database.

  10. Select Apply to save the settings.

Last modified: September 29, 2025

Was this article helpful?

On this page

Was this article helpful?

Verification instructions

Note: You must install cosign to verify the authenticity of the SingleStore file.

Use the following steps to verify the authenticity of singlestoredb-server, singlestoredb-toolbox, singlestoredb-studio, and singlestore-client SingleStore files that have been downloaded.

You may perform the following steps on any computer that can run cosign, such as the main deployment host of the cluster.

  1. (Optional) Run the following command to view the associated signature files.

    curl undefined

  2. Download the signature file from the SingleStore release server.

    • Option 1: Click the Download Signature button next to the SingleStore file.

    • Option 2: Copy and paste the following URL into the address bar of your browser and save the signature file.

    • Option 3: Run the following command to download the signature file.

      curl -O undefined

  3. After the signature file has been downloaded, run the following command to verify the authenticity of the SingleStore file.

    echo -n undefined |
        cosign verify-blob --certificate-oidc-issuer https://oidc.eks.us-east-1.amazonaws.com/id/CCDCDBA1379A5596AB5B2E46DCA385BC \
          --certificate-identity https://kubernetes.io/namespaces/freya-production/serviceaccounts/job-worker \
          --bundle undefined \
          --new-bundle-format -
    Verified OK