Skip to content

Commit 4aa45c2

Browse files
delfrrrdelfrrr
authored
Merge pull request #25 from dekart-xyz/release-0.16
Release 0.16
2 parents 71cdc3a + 96cc078 commit 4aa45c2

File tree

5 files changed

+74
-8
lines changed

5 files changed

+74
-8
lines changed

‎content/docs/configuration/environment-variables.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ images: []
2222
| `DEKART_POSTGRES_PASSWORD` | *Example*: `******`|
2323
|`DEKART_PORT`| *Example*: `8080`|
2424
|`DEKART_POSTGRES_URL` <br><small class="badge badge-info">version &gt;= 0.13</small> | Alternatively to specify `DEKART_POSTGRES_DB`, `DEKART_POSTGRES_HOST`, `DEKART_POSTGRES_PORT`, `DEKART_POSTGRES_USER`, `DEKART_POSTGRES_PASSWORD`, configure PostgreSQL by passing the connection string. If both specified `DEKART_POSTGRES_URL` is used. <br/> *Example*: `postgres://user:pass@hostname:5432/dekart?sslmode=verify-full`|
25-
|`DEKART_DATASOURCE=BQ` <br><small class="badge badge-info">version &gt;= 0.8</small> | Which datasource to use: <br>Values<ul><li>`BQ` BigQuery, default</li><li>`ATHENA` AWS Athena</li><li>`SNOWFLAKE` Snowflake <small class="badge badge-info">version &gt;= 0.12</small></li></ul>|
25+
|`DEKART_DATASOURCE=BQ` <br><small class="badge badge-info">version &gt;= 0.8</small> | Which datasource to use: <br>Values<ul><li>`BQ` BigQuery, default</li><li>`ATHENA` AWS Athena</li><li>`SNOWFLAKE` Snowflake <small class="badge badge-info">version &gt;= 0.12</small></li><li>`PG` Postgres <small class="badge badge-info">version &gt;= 0.16</small></li></ul>|
2626
| `DEKART_STORAGE=GCS` <br><small class="badge badge-info">version &gt;= 0.8</small> | Which storage backend to use for storing queries and query results <br>Values<ul><li>`GCS` Google Cloud Storage, default, works only with BigQuery data source</li><li>`S3` AWS S3, works with BigQuery and AWS Athena</li></ul>|
2727
| `DEKART_CLOUD_STORAGE_BUCKET` | Google Cloud Storage or AWS S3 bucket name where Dekart Query results will be stored. <br> *Example*: `dekart-bucket` <br><br> If value is empty, users will be able to define storage bucket via UI. Supported datasource `DEKART_DATASOURCE`: <ul><li>`BQ` BigQuery from <small class="badge badge-info">version &gt;= 0.15</small></li></ul>|
2828
| `DEKART_CORS_ORIGIN=` <br/><small class="badge badge-info">version &gt;= 0.10</small> | CORS Origin to be allowed by Dekart backend and set in `Access-Control-Allow-Origin` header. If not set or set incorrectly, warning will appear in logs. If set incorrectly. <br> *Example*: `https://dekart.example.com` |
@@ -71,6 +71,14 @@ Required to query BigQuery and use Cloud Storage
7171
| `DEKART_SNOWFLAKE_USER` <br/><small class="badge badge-info">version &gt;= 0.12</small> | Snowflake user with default warehouse configured <br> *Example*: `example_user`|
7272
| `DEKART_SNOWFLAKE_PASSWORD` <br/><small class="badge badge-info">version &gt;= 0.12</small> | Snowflake user password <br> *Example*: `******`|
7373

74+
## Postgres (as a data source)
75+
76+
Postgres can be used as a data source for Dekart. Do not confuse with Dekart's Postgres database, which is used to store query meta information.
77+
78+
| Name | Description |
79+
| ------------- | ------------- |
80+
| `DEKART_POSTGRES_DATA_CONNECTION` <br/><small class="badge badge-info">version &gt;= 0.16</small> | Postgres DB to be used as data source <br> *Example*: `postgres://user:password@host:port/db`|
81+
7482

7583
## File upload
7684

@@ -143,6 +151,9 @@ Dekart can read <a target="_blank" href="https://docs.aws.amazon.com/elasticload
143151
| `DEKART_UX_DATA_DOCUMENTATION` | Allows provide URL to dataset documentation. It will appear in Dekart UI.<br> *Example value*: `https://my.company/dataset/schema.html`|
144152
| `DEKART_HTML_CUSTOM_CODE` | Allows to add custom HTML code to `<head>`. Can be used for adding trackers. |
145153
| `DEKART_DISABLE_USAGE_STATS` <br><small class="badge badge-info">version &gt;= 0.11</small> | By default, Dekart appends certain information to the referrer of external links. This information includes the version number, the SHA256 hash of the hostname, the name of the data source, and the total number of reports, queries, files, and authors. No other information is collected. The source code for this implementation can be found [here](https://github.com/dekart-xyz/dekart/blob/main/src/client/lib/ref.js#L25). This behavior can be turned off by setting this variable to `1`.|
154+
| `DEKART_UX_ACCESS_ERROR_INFO_HTML` <br><small class="badge badge-info">version &gt;= 0.16</small> | Allows to provide custom HTML code to be shown on the access error page. |
155+
| `DEKART_UX_NOT_FOUND_ERROR_INFO_HTML` <br><small class="badge badge-info">version &gt;= 0.16</small> | Allows to provide custom HTML code to be shown on the not found error page. |
156+
| `DEKART_UX_SAMPLE_QUERY_SQL` <br><small class="badge badge-info">version &gt;= 0.16</small> | Allows to provide a sample SQL query to be shown in the query editor. |
146157

147158
## Development specific
148159

‎content/docs/self-hosting/docker.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ docker run \
4545
-e DEKART_MAPBOX_TOKEN=${DEKART_MAPBOX_TOKEN} \
4646
-e DEKART_CORS_ORIGIN=${DEKART_CORS_ORIGIN} \
4747
-p 8080:8080 \
48-
dekartxyz/dekart:0.15
48+
dekartxyz/dekart:0.16
4949
```
5050

5151
### Google BigQuery
@@ -66,7 +66,7 @@ docker run \
6666
-e DEKART_MAPBOX_TOKEN=${DEKART_MAPBOX_TOKEN} \
6767
-e DEKART_CORS_ORIGIN=${DEKART_CORS_ORIGIN} \
6868
-p 8080:8080 \
69-
dekartxyz/dekart:0.15
69+
dekartxyz/dekart:0.16
7070
```
7171

7272
### Snowflake
@@ -90,7 +90,30 @@ docker run -it --rm \
9090
-e DEKART_MAPBOX_TOKEN=${DEKART_MAPBOX_TOKEN} \
9191
-e DEKART_CORS_ORIGIN=${DEKART_CORS_ORIGIN} \
9292
-p 8080:8080 \
93-
dekartxyz/dekart:0.15
93+
dekartxyz/dekart:0.16
94+
```
95+
96+
### PostgreSQL
97+
98+
```bash
99+
docker run \
100+
-e AWS_REGION=${AWS_REGION} \
101+
-e AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID} \
102+
-e AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY} \
103+
-e DEKART_POSTGRES_DB=${DEKART_POSTGRES_DB} \
104+
-e DEKART_POSTGRES_USER=${DEKART_POSTGRES_USER} \
105+
-e DEKART_POSTGRES_PASSWORD=${DEKART_POSTGRES_PASSWORD} \
106+
-e DEKART_POSTGRES_PORT=${DEKART_POSTGRES_PORT} \
107+
-e DEKART_POSTGRES_HOST=host.docker.internal \
108+
-e DEKART_MAPBOX_TOKEN=${DEKART_MAPBOX_TOKEN} \
109+
-e DEKART_STORAGE=S3 \
110+
-e DEKART_CLOUD_STORAGE_BUCKET=${DEKART_CLOUD_STORAGE_BUCKET} \
111+
-e DEKART_DATASOURCE=PG \
112+
-e DEKART_POSTGRES_DATA_CONNECTION=${DEKART_POSTGRES_DATA_CONNECTION} \
113+
-e DEKART_MAPBOX_TOKEN=${DEKART_MAPBOX_TOKEN} \
114+
-e DEKART_CORS_ORIGIN=${DEKART_CORS_ORIGIN} \
115+
-p 8080:8080 \
116+
dekartxyz/dekart:0.16
94117
```
95118

96119

‎content/docs/self-hosting/upgrade.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,13 @@ menu:
1616
Before you begin: it is always recommended to back up your Postgres database before upgrading Dekart. On the first run, Dekart applies migrations to the database and you won't be able to downgrade.
1717
</div></p>
1818

19-
For all Docker-based deployments, update the docker tag, for example `dekartxyz/`dekart:0.14` -> `dekartxyz/dekart:0.15`
19+
For all Docker-based deployments, update the docker tag, for example `dekartxyz/`dekart:0.15` -> `dekartxyz/dekart:0.16`
2020

2121
## Migration instructions
2222

23+
**`dekartxyz/dekart:0.15` -> `dekartxyz/dekart:0.16`**
24+
No breaking changes, just update the docker tag. New Postgres migrations will be applied on the first run.
25+
2326
**`dekartxyz/dekart:0.14` -> `dekartxyz/dekart:0.15`**
2427
No breaking changes, just update the docker tag. New Postgres migrations will be applied on the first run.
2528

‎layouts/index.html

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
<div class="col-lg-9 col-xl-8 text-center">
5050
<p class="mt-2"><a class="btn btn-primary btn-lg" href="/docs/about/playground/" role="button">BigQuery Live
5151
Demo</a></p>
52-
<p><a target="_blank" href="https://github.com/dekart-xyz/dekart/releases/tag/v0.15.0">Latest open-source release 0.15.0</a></p>
52+
<p><a target="_blank" href="https://github.com/dekart-xyz/dekart/releases/tag/v0.16.0">Latest open-source release 0.16.0</a></p>
5353
</div>
5454
</div>
5555
</section>
@@ -89,18 +89,25 @@ <h2 class="h3 mt-0 mb-5 text-center">Connectors</h2>
8989
</div>
9090
<div class="col-sm">
9191
<div class="text-center">
92-
<img class="connector" src="/snowflake.svg" alt="BigQuery">
92+
<img class="connector" src="/snowflake.svg" alt="snowflake">
9393
<div class="h5 connector"><a href="/docs/configuration/environment-variables/#snowflake">Snowflake</a></div>
9494
<div class="configure-in-cloud"><small>Self-hosted only</small></div>
9595
</div>
9696
</div>
9797
<div class="col-sm">
9898
<div class="text-center">
99-
<img class="connector" src="/athena.svg" alt="BigQuery">
99+
<img class="connector" src="/athena.svg" alt="AWS Athena">
100100
<div class="h5 connector"><a href="/docs/configuration/environment-variables/#aws-athena">Athena</a></div>
101101
<div class="configure-in-cloud"><small>Self-hosted only</small></div>
102102
</div>
103103
</div>
104+
<div class="col-sm">
105+
<div class="text-center">
106+
<img class="connector" src="/postgres.svg" alt="Postgres">
107+
<div class="h5 connector"><a href="/docs/configuration/environment-variables/#postgres-as-a-data-source">Postgres</a></div>
108+
<div class="configure-in-cloud"><small>Self-hosted only</small></div>
109+
</div>
110+
</div>
104111
</div>
105112
</div>
106113
</section>

‎static/postgres.svg

Lines changed: 22 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)