Skip to content

Timescale DB

Steps to setup Timescale DB


Fill the form with the credentials of your data source.

Screenshot Screenshot

Once the form is completed, it's necessary to test the connection to verify if Qualytics is able to connect to your source of data. A successful message will be shown:

Screenshot Screenshot

Warning

By clicking on the Finish button, it will create the Datastore and skipping the configuration of an Enrichment Datastore.

  • To configure an Enrichment Datastore in another moment, please refer to this section

Note

It is important to associate an Enrichment Datastore with your new Datastore

  • The Enrichment Datastore will allow Qualytics to record enrichment data, copies of the source anomalous data and additional metadata for your Datastore

Configuring an Enrichment Datastore

Warning

Qualytics does not support Timescale DB connector as an enrichment datastore, but you can point to a different connector.

  • To configure an Enrichment Datastore in another moment, please refer to this section
  • If you have an Enrichment Datastore already setup, you can link it by enable to use an existing Enrichment Datastore and select from the list.

  • If you don't have an Enrichment Datastore, you can create one at the same page.

Once the form is completed, it's necessary to test the connection. A successful message will be shown:

Screenshot Screenshot

Warning

By clicking on the Finish button, it will create the Datastore and link or create the Enrichment Datastore


Fields

Name required

  • The datastore name to be created in Qualytics App

Host required

  • The address of the server to connect to. This address can be a DNS or IP address.

Port required

  • The port to connect to on serverName.
  • The default is 5432.

    Note: If you're using the default, you don't have to specify the port

Database required

  • The database name to be connected.

Schema required

  • The schema name to be connected.

User required

  • The user to connect in Timescale DB.

Password required

  • The password to connect in Timescale DB.

API Payload Examples

Creating a Datastore

This section provides a sample payload for creating a datastore. Replace the placeholder values with actual data relevant to your setup.

Endpoint (Post)

/api/datastores (post)

    {
        "name": "your_datastore_name",
        "teams": ["Public"],
        "database": "timescale_database",
        "schema": "timescale_schema",
        "enrich_only": false,
        "trigger_catalog": true,
        "connection": {
            "name": "your_connection_name",
            "type": "timescale",
            "host": "timescale_host",
            "port": "timescale_port",
            "username": "timescale_username",
            "password": "timescale_password"
        }
    }
    {
        "name": "your_datastore_name",
        "teams": ["Public"],
        "database": "timescale_database",
        "schema": "timescale_schema",
        "enrich_only": false,
        "trigger_catalog": true,
        "connection_id": connection-id
    }

Linking Datastore to an Enrichment Datastore through API

Endpoint (Patch)

/api/datastores/{datastore-id}/enrichment/{enrichment-id} (patch)


Last update: June 14, 2024