Skip to content

Commit 6a82260

Browse files
Updating metastore documentation with Aurora postgres example (#2706)
* added Aurora postgres to metastore documentation
1 parent 8ed89cc commit 6a82260

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

site/content/in-dev/unreleased/metastores.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,45 @@ deprecated EclipseLink persistence backends.
2929
This implementation leverages Quarkus for datasource management and supports configuration through
3030
environment variables or JVM -D flags at startup. For more information, refer to the [Quarkus configuration reference](https://quarkus.io/guides/config-reference#env-file).
3131

32+
We have 2 options for configuring the persistence backend:
3233

34+
### 1. Relational JDBC metastore with username and password
35+
36+
using environment variables:
3337
```
3438
POLARIS_PERSISTENCE_TYPE=relational-jdbc
3539
3640
QUARKUS_DATASOURCE_USERNAME=<your-username>
3741
QUARKUS_DATASOURCE_PASSWORD=<your-password>
3842
QUARKUS_DATASOURCE_JDBC_URL=<jdbc-url-of-postgres>
3943
```
44+
using properties file:
45+
46+
```
47+
polaris.persistence.type=relational-jdbc
48+
quarkus.datasource.jdbc.username=<your-username>
49+
quarkus.datasource.jdbc.password=<your-password>
50+
quarkus.datasource.jdbc.jdbc-url=<jdbc-url-of-postgres>
51+
```
52+
53+
### 2. AWS Aurora PostgreSQL metastore using IAM AWS authentication
54+
55+
```
56+
polaris.persistence.type=relational-jdbc
57+
quarkus.datasource.jdbc.url=jdbc:postgresql://polaris-cluster.cluster-xyz.us-east-1.rds.amazonaws.com:6160/polaris
58+
quarkus.datasource.jdbc.additional-jdbc-properties.wrapperPlugins=iam
59+
quarkus.datasource.username=dbusername
60+
quarkus.datasource.db-kind=postgresql
61+
quarkus.datasource.jdbc.additional-jdbc-properties.ssl=true
62+
quarkus.datasource.jdbc.additional-jdbc-properties.sslmode=require
63+
quarkus.datasource.credentials-provider=aws
64+
65+
quarkus.rds.credentials-provider.aws.use-quarkus-client=true
66+
quarkus.rds.credentials-provider.aws.username=dbusername
67+
quarkus.rds.credentials-provider.aws.hostname=polaris-cluster.cluster-xyz.us-east-1.rds.amazonaws.com
68+
quarkus.rds.credentials-provider.aws.port=6160
69+
```
70+
This is the basic configuration. For more details, please refer to the [Quarkus plugin documentation](https://docs.quarkiverse.io/quarkus-amazon-services/dev/amazon-rds.html#_configuration_reference)
4071

4172
The Relational JDBC metastore currently relies on a Quarkus-managed datasource and supports only PostgresSQL and H2 databases. This limitation is similar to that of EclipseLink, primarily due to underlying schema differences. At this time, official documentation is provided exclusively for usage with PostgreSQL.
4273
Please refer to the documentation here:

0 commit comments

Comments
 (0)