dimas-b commented on code in PR #1515:
URL: https://github.com/apache/polaris/pull/1515#discussion_r2072228634
##########
site/content/in-dev/unreleased/configuring-polaris-for-production.md:
##########
@@ -135,33 +135,19 @@ default, Polaris uses an in-memory metastore.
> The default in-memory metastore is not suitable for production use, as it
> will lose all data
> when the server is restarted; it is also unusable when multiple Polaris
> replicas are used.
-To use a durable metastore, you need to switch to the EclipseLink metastore,
and provide your own
-`persistence.xml` file. This file contains details of the database used for
metastore management and
-the connection settings. For more information, refer to the [metastore
documentation]({{% ref
-"metastores" %}}).
+To use a durable metastore, you need to switch to the Relational JDBC backed
metastore
-Then, configure Polaris to use your metastore by setting the following
properties:
+Configure the `polaris.persistence` section in your Polaris configuration file
+(`application.properties`) as follows:
-```properties
-polaris.persistence.type=eclipse-link
-polaris.persistence.eclipselink.configuration-file=/path/to/persistence.xml
-polaris.persistence.eclipselink.persistence-unit=polaris
+```
+polaris.persistence.type=relational-jdbc
Review Comment:
This is default now. There's no need for users to set it, I guess.
I suppose we may want to give an example for Data Source properties instead
:thinking: ... for a local PostgreSQL server, perhaps?
##########
site/content/in-dev/unreleased/configuring-polaris-for-production.md:
##########
@@ -135,33 +135,19 @@ default, Polaris uses an in-memory metastore.
> The default in-memory metastore is not suitable for production use, as it
> will lose all data
> when the server is restarted; it is also unusable when multiple Polaris
> replicas are used.
-To use a durable metastore, you need to switch to the EclipseLink metastore,
and provide your own
-`persistence.xml` file. This file contains details of the database used for
metastore management and
-the connection settings. For more information, refer to the [metastore
documentation]({{% ref
-"metastores" %}}).
+To use a durable metastore, you need to switch to the Relational JDBC backed
metastore
-Then, configure Polaris to use your metastore by setting the following
properties:
+Configure the `polaris.persistence` section in your Polaris configuration file
+(`application.properties`) as follows:
Review Comment:
From my POV `application.properties` is not the best place for user-level
settings. In binary distributions the default one is embedded into jar files
and not directly accessible, while the optional local file is relative to the
current directory, which is prone to runtime mistakes.
I'd suggest using java `-D` options or env. variables in user-facing docs.
Cf. https://quarkus.io/guides/config-reference
##########
site/content/in-dev/unreleased/configuring-polaris-for-production.md:
##########
@@ -135,33 +135,19 @@ default, Polaris uses an in-memory metastore.
> The default in-memory metastore is not suitable for production use, as it
> will lose all data
> when the server is restarted; it is also unusable when multiple Polaris
> replicas are used.
-To use a durable metastore, you need to switch to the EclipseLink metastore,
and provide your own
-`persistence.xml` file. This file contains details of the database used for
metastore management and
-the connection settings. For more information, refer to the [metastore
documentation]({{% ref
-"metastores" %}}).
+To use a durable metastore, you need to switch to the Relational JDBC backed
metastore
-Then, configure Polaris to use your metastore by setting the following
properties:
+Configure the `polaris.persistence` section in your Polaris configuration file
+(`application.properties`) as follows:
-```properties
-polaris.persistence.type=eclipse-link
-polaris.persistence.eclipselink.configuration-file=/path/to/persistence.xml
-polaris.persistence.eclipselink.persistence-unit=polaris
+```
+polaris.persistence.type=relational-jdbc
```
-Where:
-
-- `polaris.persistence.type` indicates that we are using the EclipseLink
metastore.
-- `polaris.persistence.eclipselink.configuration-file` is the path to the
`persistence.xml` file.
-- `polaris.persistence.eclipselink.persistence-unit` is the name of the
persistence unit to use (in
- case the configuration file has many persistence units).
-
-Typically, in Kubernetes, you would define the `persistence.xml` file as a
`ConfigMap` and set the
-`polaris.persistence.eclipselink.configuration-file` property to the path of
the mounted file in
-the container.
+Relational JDBC uses Quarkus managed datasource and only supports Postgres and
h2 as of now.
+please ref here: [How to configure jdbc Datasource via
Quarkus](https://github.com/apache/polaris/blob/main/extension/persistence/eclipselink/src/main/resources/META-INF/persistence.xml)
Review Comment:
The link is still for "eclipselink"... Is that intentional?
##########
site/content/in-dev/unreleased/metastores.md:
##########
@@ -101,7 +117,7 @@ java -Dpolaris.persistence.type=eclipse-link \
-jar quarkus/server/build/quarkus-app/quarkus-run.jar
```
-### Using Postgres
+##### Using Postgres
Review Comment:
Should this have 4 `#` marks a for H2?
##########
site/content/in-dev/unreleased/configuring-polaris-for-production.md:
##########
@@ -135,33 +135,19 @@ default, Polaris uses an in-memory metastore.
> The default in-memory metastore is not suitable for production use, as it
> will lose all data
> when the server is restarted; it is also unusable when multiple Polaris
> replicas are used.
-To use a durable metastore, you need to switch to the EclipseLink metastore,
and provide your own
-`persistence.xml` file. This file contains details of the database used for
metastore management and
-the connection settings. For more information, refer to the [metastore
documentation]({{% ref
-"metastores" %}}).
+To use a durable metastore, you need to switch to the Relational JDBC backed
metastore
-Then, configure Polaris to use your metastore by setting the following
properties:
+Configure the `polaris.persistence` section in your Polaris configuration file
+(`application.properties`) as follows:
-```properties
-polaris.persistence.type=eclipse-link
-polaris.persistence.eclipselink.configuration-file=/path/to/persistence.xml
-polaris.persistence.eclipselink.persistence-unit=polaris
+```
+polaris.persistence.type=relational-jdbc
```
-Where:
-
-- `polaris.persistence.type` indicates that we are using the EclipseLink
metastore.
-- `polaris.persistence.eclipselink.configuration-file` is the path to the
`persistence.xml` file.
-- `polaris.persistence.eclipselink.persistence-unit` is the name of the
persistence unit to use (in
- case the configuration file has many persistence units).
-
-Typically, in Kubernetes, you would define the `persistence.xml` file as a
`ConfigMap` and set the
-`polaris.persistence.eclipselink.configuration-file` property to the path of
the mounted file in
-the container.
+Relational JDBC uses Quarkus managed datasource and only supports Postgres and
h2 as of now.
+please ref here: [How to configure jdbc Datasource via
Quarkus](https://github.com/apache/polaris/blob/main/extension/persistence/eclipselink/src/main/resources/META-INF/persistence.xml)
-> [!IMPORTANT]
-> Be sure to secure your metastore backend since it will be storing sensitive
data and catalog
-> metadata.
+Note: Polaris will create schema named 'polaris_schema' always under the
configured database via Quarkus.
Review Comment:
Is schema creation happening in normal runtime or only when bootstrapping (I
think the latter is the right approach).
##########
site/content/in-dev/unreleased/metastores.md:
##########
@@ -32,6 +32,22 @@ In order to add other JDBC drivers, you have to build
Polaris using the `eclipse
## Polaris Server Configuration
+#### Relational JDBC
+Configure the `polaris.persistence` section in your Polaris configuration file
+(`application.properties`) as follows:
+
+```
+polaris.persistence.type=relational-jdbc
+```
+
+Relational JDBC uses Quarkus managed datasource and only supports Postgres and
h2 as of now.
+please ref here: [How to configure jdbc Datasource via
Quarkus](https://github.com/apache/polaris/blob/main/extension/persistence/eclipselink/src/main/resources/META-INF/persistence.xml)
Review Comment:
EclipseLink in the URL?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
