Connections
Last updated
Last updated
Connections are used to connect to external systems. For example, they are used to read and write data from databases, files, and other systems when running replications.
Each project has an internal env.yaml file, which is used to store the connection credentials. This file is used to authenticate the agent when it needs to access the external system. When using the project env.yaml file, the credentials are securely transmitted over TLS and encrypted at rest.
You can also define a local env.yaml file (saved on the agent machine), which can be used to authenticate the agent when it needs to access the external system. When using the local env.yaml file, the credentials are never transmitted outside the agent machine. Only the name and type of the connection are sent to the control server for displaying on the UI.
To add a connection to the project env.yaml file, you can click on the New button on the connections page and then select the type of connection you want to add.
You can then fill in the connection details and click on the Save button to add the connection to the project env.yaml file. You can also click on the Test button to test the connection before saving it.
Note that objects are accessed in a read-only fashion, therefore no changes can be made to the data.
You can explore the files or tables in a connection by clicking one on the left sidebar. This allows you to see which objects are available, as well as previewing the data inside. This is useful for getting familiar with the data, and for finding the correct object names for your replications.
