lightbulb

Learn how to connect your databases and cloud buckets to MOSTLY AI.

list

If you want to synthesize databases, you’ll need to create two data connectors
—one for the source and another for the destination.
Please ensure that your destination database or cloud bucket have the appropriate write permissions configured.

clock

It will take 10 mins to complete this guide.


MOSTLY AI currently only supports single-column primary keys in sequential or UUID format. Databases and datasets with complex keys, such as natural keys (e.g., social security numbers), composite keys (spanning multiple keys), or compound keys (e.g., PK = FK), require preprocessing before they can be synthesized.


green 1 Select Connectors from the top main menu and click Create Connector.

Connectors page


green 2 Select the data source type

A drawer appears where you can configure the new connector.
Use the tabs to select the type of data source you want to connect to and click Proceed.

Data catalog workflow overview


green 3 Fill out the authentication details

Next, you’ll need to fill out the authentication details for your data source.
Please select the appropriate instructions for filling out these fields from the list below.

For database data connectors, MOSTLY AI needs to know which schema to export the synthetic data to. For PostgreSQL and MySQL databases, this field can be left blank so that the default schema will be used.

Database

DB2

  • Connector name
    You can optionally enter a name for this data connector. This will help with finding the right connector when creating a data catalog.

  • Hostname
    Enter the hostname of the database server.

  • Username
    Enter the username for the database you want to connect to.

  • Password
    Enter the password for this username.

  • Name of the database
    Enter the name of the database you want to connect to.

  • Schema
    Specify the name of the schema to use.

DB2 authentication details modal
MariaDb

  • Connector name
    You can optionally enter a name for this data connector. This will help with finding the right connector when creating a data catalog.

  • Hostname
    Enter the hostname of the database server.

  • Username
    Enter the username for the database you want to connect to.

  • Password
    Enter the password for this username.

  • Name of the database
    Enter the name of the database you want to connect to.

  • Schema (optional)
    Leave blank to use the default schema or specify the name of the schema to use.

MariaDb authentication details modal
MS SQL Server

  • Connector name
    You can optionally enter a name for this data connector. This will help with finding the right connector when creating a data catalog.

  • Hostname
    Enter the hostname of the database server.

  • Username
    Enter the username for the database you want to connect to.

  • Password
    Enter the password for this username.

  • Name of the database
    Enter the name of the database you want to connect to.

  • Schema
    Specify the name of the schema to use.

MS SQL Server authentication details modal
MySQL

  • Connector name
    You can optionally enter a name for this data connector. This will help with finding the right connector when creating a data catalog.

  • Hostname
    Enter the hostname of the database server.

  • Username
    Enter the username for the database you want to connect to.

  • Password
    Enter the password for this username.

  • Name of the database
    Enter the name of the database you want to connect to.

  • Schema (optional)
    Leave blank to use the default schema or specify the name of the schema to use.

MySQL authentication details modal
Oracle

  • Connector name
    You can optionally enter a name for this data connector. This will help with finding the right connector when creating a data catalog.

  • Hostname
    Enter the hostname of the database server.

  • Port
    Enter the port of the database server.

  • Connection type
    Specify either SID or SERVICE_NAME.

  • Username
    Enter the username for the database you want to connect to.

  • Password
    Enter the password for this username.

  • Name of the database
    Enter the name of the database you want to connect to.

  • Schema
    Specify the name of the schema to use.

Oracle authentication details modal
PostgreSQL

  • Connector name
    You can optionally enter a name for this data connector. This will help with finding the right connector when creating a data catalog.

  • Hostname
    Enter the hostname of the database server.

  • Username
    Enter the username for the database you want to connect to.

  • Password
    Enter the password for this username.

  • Name of the database
    Enter the name of the database you want to connect to.

  • Schema (optional)
    Leave blank to use the default schema or specify the name of the schema to use.

PostgreSQL authentication details modal

Cloud storage

Azure

  • Connector name
    You can optionally enter a name for this data connector. This will help with finding the right connector when creating a data catalog.

  • Account name
    Enter the storage account name.

  • Account key
    Enter the storage account key.

  • Container
    Enter the address of the container you want to connect to.

Azure authentication details modal
AWS

  • Connector name
    You can optionally enter a name for this data connector. This will help with finding the right connector when creating a data catalog.

  • Access key
    Enter the Access Key ID for the user created for use with MOSTLY AI.

  • Secret key
    Enter the Secret Access Key for the user created for use with MOSTLY AI.

  • Region
    Enter the region where the bucket is located.

  • Bucket name
    Enter the name of your Amazon S3 bucket.

AWS authentication details modal
GCP

  • Connector name
    You can optionally enter a name for this data connector. This will help with finding the right connector when creating a data catalog.

  • User/Service-Account Credentials JSON
    Paste the JSON with your user or service account credentials in this field.

  • Bucket name
    Enter the name of the bucket.

GCP authentication details modal


green 4 Test connection

Once you filled out all the fields, you can click Test connection to verify the authentication details. MOSTLY AI will indicate whether it can connect to the database.

test connection


green 4 Review your newly-created connector

You can see your newly created data connector in the Connectors page.
Click on the expand icon to review the authentication details. There are also options to edit, delete, share, the connector, or copy the connector ID for use in API calls.

Connectors list with expanded row


Sharing your data connector

You can share your data connector with other user groups. The sharing options also let you grant read access to all authenticated users or transfer the data catalog’s ownership to another user.

To do so, click on the expand button of the connector you want to share and click Share.

Share button in jobs list

A drawer appears where you can select the groups you want to share the data connector with, grant read access to all authenticated users, or transfer the connector’s ownership to another user:

Sharing modal

After clicking Save, you’ll be asked to confirm your choices. A transfer of ownership or change of groups may cause you to lose access to this data connector. Please review whether this is the case and, if so, whether it’s intended.