You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix(docs): sync-up with deployed changes on Fivetran (#37655)
Fixes and updates the documentation according to the changes made by Fivetran’s Technical Writing team to align with Fivetran standards.
#106
GitOrigin-RevId: 2c323fb9bba4babd7d6ceab2485c3c07047e8c3e
[Convex](https://convex.dev) is a full-stack TypeScript development platform with product-centric APIs. It can replace your database and server functions.
12
12
13
-
> NOTE: Fivetran supports Convex as both a partner-built [database connector](/docs/databases/convex) and a destination.
13
+
> NOTE: Fivetran supports Convex as both a partner-built [database connector](/docs/databases/convex) and a partner-built destination.
14
14
15
15
> NOTE: This destination is [partner-built](/docs/partner-built-program). For any questions related to the Convex destination and its documentation, refer to Convex's support team. For SLA details, see [Convex's Status and Guarantees documentation](https://docs.convex.dev/production/state).
16
16
@@ -71,4 +71,4 @@ Convex deployments do not have a concept of namespaced tables, so it uses this n
71
71
the namespace information.
72
72
73
73
Column names that begin with `_` are not supported in Convex. Instead, those columns are synced to the
74
-
destination nested within the `fivetran.columns` column. For example, a column named `_line` would be synced as a nested column named `fivetran.columns.line`.
74
+
destination nested within the `fivetran.columns` column. For example, a column named `_line` would be synced as a nested column named `fivetran.columns.line`.
[Convex](https://convex.dev) is an all-in-one backend platform with thoughtful, product-centric APIs.
9
+
[Convex](https://convex.dev) is a full-stack TypeScript development platform. Replace your database, server functions, and glue code.
10
10
11
-
Note that Convex can also be set up as a [destination](/docs/destinations/convex_destination)
11
+
> NOTE: This connector is [partner-built](/docs/partner-built-program). For any questions related to Convex connector and its documentation, refer to Convex's support team. For details on SLA, see [Convex's Status and Guarantees documentation](https://docs.convex.dev/production/state).
12
+
13
+
----
14
+
15
+
## Features
16
+
17
+
{% featureTable connector="convex" /%}
12
18
13
19
---
14
20
15
21
## Setup guide
16
22
17
-
Follow our[step-by-step Convex setup guide](/docs/databases/convex/setup-guide) to connect your Convex database with Fivetran.
23
+
Follow the[step-by-step Convex setup guide](/docs/connectors/databases/convex/setup-guide) to connect your Convex database with Fivetran.
18
24
19
25
---
20
26
21
27
## Sync overview
22
28
23
-
Once Fivetran is connected to your Convex deployment, the connector fetches an initial consistent snapshot of all data from your Convex database. Once the initial sync is complete, the connector uses CDC to efficiently incrementally sync updates at a newer consistent view of your Convex deployment. You can configure the frequency of these updates.
29
+
Once Fivetran is connected to your Convex deployment, the connection fetches an initial consistent snapshot of all data from your Convex database. Once the initial sync is complete, the connection uses Change data capture (CDC) to efficiently incrementally sync updates at a newer consistent view of your Convex deployment. You can configure the frequency of these updates.
24
30
25
31
---
26
32
27
33
## Configuration
28
34
29
-
You will need your deployment URL and deploy key in order to configure the Convex Connector for Fivetran. You can find both on your project's [Production Deployment Settings page](https://docs.convex.dev/dashboard/deployments/deployment-settings).
35
+
To configure a Convex connection, you need your deployment URL and deploy key. You can find both on your project's [Production Deployment Settings page](https://docs.convex.dev/dashboard/deployments/deployment-settings).
30
36
31
37
---
32
38
33
39
## Schema information
34
40
35
-
Fivetran tries to replicate the database and columns from your configured Convex deployment to your destination according to Fivetran's [standard database update strategies](/docs/databases#transformationandmappingoverview).
41
+
Fivetran tries to replicate the database and columns from your configured Convex deployment to your destination according to Fivetran's [standard database update strategies](/docs/connectors/databases#transformationandmappingoverview).
36
42
37
43
### Type transformations and mapping
38
44
39
-
As the connector extracts your data, it matches [Convex data types](https://docs.convex.dev/database/types) to types that Fivetran supports.
45
+
As the connection extracts your data, it matches [Convex data types](https://docs.convex.dev/database/types) to types that Fivetran supports.
40
46
41
-
The following table illustrates how the connector transforms your Convex data types into Fivetran-supported types:
47
+
The following table illustrates how the connection transforms your Convex data types into Fivetran-supported types:
42
48
43
49
| Convex Type | Fivetran Type | Fivetran Supported |
@@ -58,7 +64,7 @@ The following table illustrates how the connector transforms your Convex data ty
58
64
59
65
### Nested data
60
66
61
-
Convex documents are represented as JSON [by using conversions](https://docs.convex.dev/database/types). If the first-level field is a simple data type, the connector will map it to its own type. If it's a complex nested data type such as an array or JSON data, it maps to a JSON type without unpacking. The connector does not automatically unpack nested JSON objects to separate tables in the destination. Any nested JSON objects are preserved as is in the destination so that you can use JSON processing functions.
67
+
Convex documents are represented as JSON [by using conversions](https://docs.convex.dev/database/types). If the first-level field is a simple data type, the connection will map it to its own type. If it's a complex nested data type such as an array or JSON data, it maps to a JSON type without unpacking. The connection does not automatically unpack nested JSON objects to separate tables in the destination. Any nested JSON objects are preserved as is in the destination so that you can use JSON processing functions.
62
68
63
69
For example, the following Convex document:
64
70
@@ -75,7 +81,7 @@ For example, the following Convex document:
75
81
}
76
82
```
77
83
78
-
is converted to the following table when the connector loads it into your destination:
84
+
is converted to the following table when the connection loads it into your destination:
79
85
80
86
|\_id | street | city | country | phone | zip code | people | car |
@@ -88,4 +94,4 @@ Fivetran adds the following column to every table in your destination:
88
94
-`_fivetran_synced` (UTC TIMESTAMP) indicates the time when Fivetran last successfully synced the row. It is added to every table.
89
95
-`_fivetran_deleted` (BOOLEAN) indicates if the column was deleted in the source.
90
96
91
-
Fivetran adds these columns to give you insight into the state of your data and the progress of your data syncs.
97
+
Fivetran adds these columns to give you insight into the state of your data and the progress of your data syncs. For more information about these columns, see [our System Columns and Tables documentation](/docs/core-concepts/system-columns-and-tables).
Follow our setup guide to connect Convex to Fivetran.
11
+
Follow the setup guide to connect Convex to Fivetran.
13
12
14
-
Note that Convex can also be set up as a [destination](/docs/destinations/convex)
13
+
> NOTE: This connector is [partner-built](/docs/partner-built-program). For any questions related to Convex connector and its documentation, contact Convex's support team. For details on SLA, see [Convex's Status and Guarantees documentation](https://docs.convex.dev/production/state).
15
14
16
15
---
17
16
18
-
19
-
20
17
## Prerequisites
21
18
22
-
To connect your Convex deployment to Fivetran, you need the following:
23
-
- A Convex account on a[Professional plan](https://www.convex.dev/pricing)
19
+
To connect your Convex deployment to Fivetran, you need the following:
20
+
- A Convex account on the[Professional plan](https://www.convex.dev/plans).
24
21
- A Convex deployment. See [Convex's documentation](https://docs.convex.dev/) to get started.
25
-
- Your Convex deployment's URL (e.g., `https://jaded-raven-991.convex.cloud`)
26
-
- Your Convex deployment's deploy key. You can find both the deployment URL and deploy key on the [Production Deployment Settings](https://docs.convex.dev/dashboard/deployments/deployment-settings) page.
22
+
- Your Convex deployment's URL (for example, `https://jaded-raven-991.convex.cloud`).
23
+
- Your Convex deployment's deploy key. You can find both the deployment URL and deploy key on the [Production Deployment Settings](https://docs.convex.dev/dashboard/deployments/deployment-settings) page.
27
24
28
25
---
29
26
30
-
31
-
32
27
## Setup instructions
33
28
34
-
35
-
36
-
> IMPORTANT: You must have a [Convex Professional plan](https://www.convex.dev/pricing) to be able use the Convex connector.
37
-
38
-
### <spanclass="step-item">Locate your Deployment Credentials</span>
29
+
### <spanclass="step-item">Find your deployment credentials</span>
39
30
40
-
1.Navigate to your deployment on the [Convex Dashboard](https://dashboard.convex.dev/).
41
-
2.Navigate to the [Production Deployment Settings](https://docs.convex.dev/dashboard/deployments/deployment-settings).
31
+
1.Go to your deployment on the [Convex dashboard](https://dashboard.convex.dev/).
32
+
2.Go to the [Production Deployment Settings](https://docs.convex.dev/dashboard/deployments/deployment-settings).
42
33
3. Find your deployment URL and deploy key and make a note of them. You will need them to configure Fivetran.
1. In your [connector setup form](/docs/getting-started/fivetran-dashboard/connectors#addanewconnector), enter a destination schema prefix. This prefix applies to each replicated schema and cannot be changed once your connector is created.
47
-
2.Select Convex as your source connector.
48
-
3. Enter your deployment credentials.
49
-
4. Click **Save & Test**. Fivetran tests and validates our connection to your Convex deployment. Upon successful completion of the setup tests, you can sync your data using Fivetran.
37
+
1. In your [connection setup form](/docs/using-fivetran/fivetran-dashboard/connectors#addanewconnection), enter a **Destination schema prefix**. This prefix applies to each replicated schema and cannot be changed once your connection is created.
38
+
2.Enter the **Deployment URL** you found.
39
+
3. Enter your **Deploy Key** you found.
40
+
4. Click **Save & Test**. Fivetran tests and validates our connection to your Convex deployment. Upon successful completion of the setup tests, you can sync your data using Fivetran.
50
41
51
42
### Setup tests
52
43
53
44
Fivetran performs the following tests to ensure that we can connect to your Convex deployment.
54
45
55
46
- Validating that your deployment credentials.
56
-
- Ensuring you are on a [Convex Professional plan](https://www.convex.dev/pricing).
47
+
- Ensuring you are on a [Convex Professional plan](https://www.convex.dev/plans).
0 commit comments