Working with connections in Soma
A connection in Soma holds information such as user credentials and host details, crucial for establishing a connection to a data source.
When using a connection in Soma and creating an axon, Algoreus generates the axon with the relevant source node and the Soma transformation. The source node is configured with all properties present in the connection.
A connection allows you to browse and sample data in supported data sources. For instance, if an Algoreus Administrator sets up a connection to BigQuery, you can utilize this connection to locate the dataset on which you want to conduct data cleansing and quality checks.
Without a connection, you are required to manually add the source node to the axon and set it up.
Note: When establishing a connection, Soma must be able to access the source.
Adding a Connection
Note: Prior to adding a database source connection, you need to upload the JDBC driver to Algoreus. This can be done from the Hub or the Namespace Admin page.
To add a connection, execute the following steps:
Go to the Soma home page and select Add Connection.
From the Add a connection page, select the type of connection you wish to create.
Configure the connection properties.
Note: Connection names must be unique in a namespace and can include only letters, numbers, underscores, and hyphens.
It's good practice to select Test Connection to ensure the connection works.
Click Create.
The connection is now displayed under the connection type and is available for all namespace users. The connection can be utilized in Soma and in the corresponding source node in the Algoreus Genesis.
Modifying a Connection
To edit connection properties, execute these steps:
Click on the name of the connection you want to modify. The connections are grouped by type on the left panel.
Click the three dots and select Edit. You can review and test the connection properties.
Click Save.
Cloning a Connection
You may want to clone connections to share them with other team members, add them to version control, or move them from a development environment to a test or production environment.
To clone a connection, perform these steps:
Click on the name of the connection you want to duplicate. Connections are grouped by type on the left panel.
Click the three dots and select Duplicate. Algoreus creates a new connection using the properties of the original connection.
Enter a Name for the connection.
Note: Connection names must be unique within a namespace.
Edit the connection properties.
Click Test Connection and resolve any issues that arise.
Click Create.
The new connection is now available for use in Soma and the corresponding source node in the Algoreus Genesis.
Removing a Connection
To delete a connection, perform these steps:
Click on the name of the connection you want to delete. Connections are categorized by type on the left panel.
Click the three dots and select Delete. Algoreus removes the connection, making it unavailable for use.
Using a Connection
To use a connection in Soma, follow these steps:
Click on the name of the connection you want to use. Connections are organized by type on the left panel.
Find the entity you wish to wrangle. Soma displays up to 1000 entities per page.
Click the entity.
Note: Not all entities can be sampled. Continue browsing until you find a sampleable entity.
The entity is ready for wrangling.
After performing the necessary transformations on the data, click Create Axon and select Batch Axon.
Algoreus creates an axon, adding a batch source node and a Soma transformation.
Algoreus fills the source node properties with the properties set in the connection.
Last updated