diff --git a/website/docs/docs/community-adapters.md b/website/docs/docs/community-adapters.md index d1e63f03128..1faf2fd9e25 100644 --- a/website/docs/docs/community-adapters.md +++ b/website/docs/docs/community-adapters.md @@ -17,4 +17,4 @@ Community adapters are adapter plugins contributed and maintained by members of | [TiDB](/docs/core/connect-data-platform/tidb-setup) | [Firebolt](/docs/core/connect-data-platform/firebolt-setup) | [MindsDB](/docs/core/connect-data-platform/mindsdb-setup) | [Vertica](/docs/core/connect-data-platform/vertica-setup) | [AWS Glue](/docs/core/connect-data-platform/glue-setup) | [MySQL](/docs/core/connect-data-platform/mysql-setup) | | [Upsolver](/docs/core/connect-data-platform/upsolver-setup) | [Databend Cloud](/docs/core/connect-data-platform/databend-setup) | [fal - Python models](/docs/core/connect-data-platform/fal-setup) | -| [TimescaleDB](https://dbt-timescaledb.debruyn.dev/) | | | +| [TimescaleDB](https://dbt-timescaledb.debruyn.dev/) | [Extrica](/docs/core/connect-data-platform/extrica-setup) | | diff --git a/website/docs/docs/core/connect-data-platform/extrica-setup.md b/website/docs/docs/core/connect-data-platform/extrica-setup.md new file mode 100644 index 00000000000..8125e6e3749 --- /dev/null +++ b/website/docs/docs/core/connect-data-platform/extrica-setup.md @@ -0,0 +1,80 @@ +--- +title: "Extrica Setup" +description: "Read this guide to learn about the Extrica Trino Query Engine setup in dbt." +id: "extrica-setup" +meta: + maintained_by: Extrica, Trianz + authors: Gaurav Mittal, Viney Kumar, Mohammed Feroz, and Mrinal Mayank + github_repo: 'extricatrianz/dbt-extrica' + pypi_package: 'dbt-extrica' + min_core_version: 'v1.7.2' + cloud_support: 'Not Supported' + min_supported_version: 'n/a' + platform_name: 'Extrica' +--- +

Overview of {frontMatter.meta.pypi_package}

+ + +

Installing {frontMatter.meta.pypi_package}

+ +Use `pip` to install the adapter, which automatically installs `dbt-core` and any additional dependencies. Use the following command for installation: + +python -m pip install {frontMatter.meta.pypi_package} + + +

Connecting to {frontMatter.meta.platform_name}

+ +#### Example profiles.yml +Here is an example of dbt-extrica profiles. At a minimum, you need to specify `type`, `method`, `username`, `password` `host`, `port`, `schema`, `catalog` and `threads`. + + +```yaml +: + outputs: + dev: + type: extrica + method: jwt + username: [username for jwt auth] + password: [password for jwt auth] + host: [extrica hostname] + port: [port number] + schema: [dev_schema] + catalog: [catalog_name] + threads: [1 or more] + + prod: + type: extrica + method: jwt + username: [username for jwt auth] + password: [password for jwt auth] + host: [extrica hostname] + port: [port number] + schema: [dev_schema] + catalog: [catalog_name] + threads: [1 or more] + target: dev + +``` + + +#### Description of Extrica Profile Fields + +| Parameter | Type | Description | +|------------|----------|------------------------------------------| +| type | string | Specifies the type of dbt adapter (Extrica). | +| method | jwt | Authentication method for JWT authentication. | +| username | string | Username for JWT authentication. The obtained JWT token is used to initialize a trino.auth.JWTAuthentication object. | +| password | string | Password for JWT authentication. The obtained JWT token is used to initialize a trino.auth.JWTAuthentication object. | +| host | string | The host parameter specifies the hostname or IP address of the Extrica's Trino server. | +| port | integer | The port parameter specifies the port number on which the Extrica's Trino server is listening. | +| schema | string | Schema or database name for the connection. | +| catalog | string | Name of the catalog representing the data source. | +| threads | integer | Number of threads for parallel execution of queries. (1 or more) | diff --git a/website/sidebars.js b/website/sidebars.js index 27bcd1147a3..89b1e005a8c 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -212,6 +212,7 @@ const sidebarSettings = { "docs/core/connect-data-platform/decodable-setup", "docs/core/connect-data-platform/upsolver-setup", "docs/core/connect-data-platform/starrocks-setup", + "docs/core/connect-data-platform/extrica-setup", ], }, ],