Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate Quickstart to use PokeAPI #4615

Merged
merged 2 commits into from
Jul 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/getting-started-logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/getting-started-source.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/quickstart/add-a-destination.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ To set it up, just follow the instructions on the screenshot below.
You might have to wait ~30 seconds before the fields show up because it is the first time you're using Airbyte.
{% endhint %}

![](../.gitbook/assets/demo_destination.png)
![](../.gitbook/assets/getting-started-destination.png)

6 changes: 4 additions & 2 deletions docs/quickstart/add-a-source.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Add a Source

Our demo source will pull data from an external API. It will replicate the closing price of currencies compared to USD since the specified start date.
You can either follow this tutorial from the onboarding or through the UI, where you can first navigate to the `Sources` tab on the right bar.

Our demo source will pull data from an external API, which will pull down the information on one specified Pokémon.

To set it up, just follow the instructions on the screenshot below.

{% hint style="info" %}
You might have to wait ~30 seconds before the fields show up because it is the first time you're using Airbyte.
{% endhint %}

![](../.gitbook/assets/demo_source.png)
![](../.gitbook/assets/getting-started-source.png)

18 changes: 9 additions & 9 deletions docs/quickstart/set-up-a-connection.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,39 @@
# Set up a Connection

When we create the connection, we can select which data stream we want to replicate. We can also select if we want an incremental replication. The replication will run at the specified sync frequency.
When we create the connection, we can select which data stream we want to replicate. We can also select if we want an incremental replication, although it isn't currently offered for this source. The replication will run at the specified sync frequency.

To set it up, just follow the instructions on the screenshot below.

![](../.gitbook/assets/demo_connection.png)
![](../.gitbook/assets/getting-started-connection.png)

## Check the logs of your first sync

After you've completed the onboarding, you will be redirected to the source list and will see the source you just added. Click on it to find more information about it. You will now see all the destinations connected to that source. Click on it and you will see the sync history.

From there, you can look at the logs, download them, force a sync and adjust the configuration of your connection.

![](../.gitbook/assets/demo_history.png)
![](../.gitbook/assets/getting-started-logs.png)

## Check the data of your first sync

Now let's verify that this worked:

```bash
cat /tmp/airbyte_local/json_data/_airbyte_raw_exchange_rate.jsonl
cat /tmp/airbyte_local/json_data/_airbyte_raw_pokemon.jsonl
```

You should see one line for each day that was replicated.

If you have [`jq`](https://stedolan.github.io/jq/) installed, let's look at the evolution of `EUR`.
If you have [`jq`](https://stedolan.github.io/jq/) installed, let's look at some of the data that we have replicated about `charizard`. We'll pull its abilities and weight:

```bash
cat /tmp/airbyte_local/test_json/_airbyte_raw_exchange_rate.jsonl |
jq -c '.data | {date: .date, EUR: .EUR }'
cat _airbyte_raw_pokemon.jsonl |
jq '._airbyte_data | {abilities: .abilities, weight: .weight}'
```

And there you have it. You've pulled data from an API directly into a file and all of the actual configuration for this replication only took place in the UI.
And there you have it. You've pulled data from an API directly into a file, with all of the actual configuration for this replication only taking place in the UI.

Note: If you are using Airbyte on Windows with WSL2 and Docker, refer to [this tutorial](../tutorials/locating-files-local-destination.md) or [this section](../integrations/destinations/local-json.md#access-replicated-data-files) in the local-json destination guide to locate the replicated folder and file.
Note: If you are using Airbyte on Windows with WSL2 and Docker, refer to [this tutorial](../operator-guides/locating-files-local-destination.md) or [this section](../integrations/destinations/local-json.md#access-replicated-data-files) in the local-json destination guide to locate the replicated folder and file.

## That's it!

Expand Down