Back to Airbyte

Add and manage sources

docs/platform/using-airbyte/getting-started/add-a-source.md

2.0.03.8 KB
Original Source

import ConnectorSetupAssistant from './_connector-setup-assistant.md';

Add and manage sources

A source is the database, API, or other system from which you sync data. Adding a source connector is the first step when you want to start syncing data with Airbyte.

Add a source connector

Add a new source connector to Airbyte.

  1. In the left navigation, click Sources.

  2. Click New Source.

  3. Find the source you want to add. If you're not sure yet, click the Marketplace tab, then click Sample Data. Sample Data is a popular test source that generates random data.

  4. Configure your connector. Every connector has different options and settings, but you normally enter things like authentication information and the location where you store your data. Two setup interfaces are possible.

    • If you use Airbyte Cloud, you can set up connectors with help from the Connector Setup Assistant. In this case, the AI asks you questions and gives you context, and you provide the setup information. For help interacting with the AI, see Set up source connectors with AI.

    • If you use a self-managed version of Airbyte, or if the AI doesn't yet support this connector, you see a setup form and documentation. In this case, fill out the form to setup your connector, then click Set up source. Airbyte tests the source to ensure it can make a connection. Once the test completes, Airbyte takes you to the New Connection page, where you can set up a new destination connector, or choose one you previously created.

<Navattic id="cmhfh6qf4000004kz0e7sa8a5" />

Modify a source connector

After you set up a source connector, you can modify it.

  1. In the left navigation, click Sources.

  2. Find and click the source connector you want to modify.

  3. Configure your connector using the form on the left side of your screen. Every connector has different options and settings, but you normally enter things like authentication information and the location where you store your data. Use the documentation panel on the right side of your screen for help populating the form.

  4. Click Test and save. Airbyte tests the source to ensure it can make a connection.

Delete a source connector

You can delete a source you no longer need.

:::danger Deleting a source connector also deletes any connections that rely on it. Data that's already in your destination isn't affected. However, reestablishing this connection later requires a full re-sync. :::

  1. In the left navigation, click Sources.

  2. Find and click the source connector you want to modify.

  3. Click Delete this source.

  4. In the dialog, type the name of the connector, then click Delete.

Set up connectors with AI (BETA) {#ai-agent}

<ConnectorSetupAssistant />

Reuse source connectors

Connectors are reusable. In most cases, you only need to set up the connector once, and you can use it in as many connections as you need to.

In a few cases, you might need to set up the same source connector multiple times. For example, if you are pulling data from multiple accounts that have unique authentication, you need a separate connector for each account.

If you don't see the connector you need

If Airbyte doesn't have the connector you need, you can create your own. In most cases, you want to use the Connector Builder, a no-code/low-code development environment in Airbyte's UI.

Other ways to manage sources

Airbyte has other options to manage connectors, too.

In these cases, you can speed up the process by entering your values into the UI, then clicking the Copy JSON button. This copies your configuration as a JSON string that you can paste into your code.