You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@polaris.apache.org by "danielvdende (via GitHub)" <gi...@apache.org> on 2024/08/23 09:45:28 UTC
[PR] Add extra docs about using EclipseLink [polaris]
danielvdende opened a new pull request, #195:
URL: https://github.com/apache/polaris/pull/195
# Description
This PR adds a little bit of information in the docs on how to get up and running with EclipseLink. Perhaps this is obvious to experienced EclipseLink users but for newbies (like me) to EclipseLInk this was not clear.
## Type of change
Please delete options that are not relevant.
- [x] This change requires a documentation update
# How Has This Been Tested?
not applicable
# Checklist:
Please delete options that are not relevant.
- [x] I have performed a self-review of my code
--
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: commits-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add extra docs about using EclipseLink [polaris]
Posted by "RussellSpitzer (via GitHub)" <gi...@apache.org>.
RussellSpitzer commented on code in PR #195:
URL: https://github.com/apache/polaris/pull/195#discussion_r1733945789
##########
docs/configuring-polaris-for-production.md:
##########
@@ -55,6 +55,13 @@ Be sure to secure your metastore backend since it will be storing credentials an
To use [EclipseLink](https://eclipse.dev/eclipselink/) for metastore management, specify the configuration `metaStoreManager.conf-file` to point to an [EclipseLink `persistence.xml` file](https://eclipse.dev/eclipselink/documentation/2.5/solutions/testingjpa002.htm). This file, local to the Polaris service, will contain information on what database to use for metastore management and how to connect to it.
+> [!IMPORTANT]
+> To use EclipseLink, you need to ensure that you have done two things:
Review Comment:
A few nits,
Avoid "you" - EclipseLink requires:
2. Set the `eclipseLink` gradle property to true within the Polaris build.
--
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: commits-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add extra docs about using EclipseLink [polaris]
Posted by "eric-maynard (via GitHub)" <gi...@apache.org>.
eric-maynard commented on code in PR #195:
URL: https://github.com/apache/polaris/pull/195#discussion_r1731542960
##########
docs/configuring-polaris-for-production.md:
##########
@@ -55,6 +55,13 @@ Be sure to secure your metastore backend since it will be storing credentials an
To use [EclipseLink](https://eclipse.dev/eclipselink/) for metastore management, specify the configuration `metaStoreManager.conf-file` to point to an [EclipseLink `persistence.xml` file](https://eclipse.dev/eclipselink/documentation/2.5/solutions/testingjpa002.htm). This file, local to the Polaris service, will contain information on what database to use for metastore management and how to connect to it.
+> [!IMPORTANT]
+> To use [EclipseLink](https://eclipse.dev/eclipselink), you need to ensure that you have done two things:
+> 1. Build the jar for the EclipseLink extension
+> 2. Set the property on the Polaris project to include eclipseLink.
+>
+> This can be achieved by setting `eclipseLink=true` in the `gradle.properties` file, or by passing the property explicitly while building all jars, e.g.: `./gradlew -PeclipseLink=true clean assemble`
+
Review Comment:
I think it's okay to have it here, approved for now with a few comments. In the future it might be neat to have a doc enumerating the different MetastoreManager options, and we could link to that doc from here.
--
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: commits-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add extra docs about using EclipseLink [polaris]
Posted by "eric-maynard (via GitHub)" <gi...@apache.org>.
eric-maynard merged PR #195:
URL: https://github.com/apache/polaris/pull/195
--
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: issues-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add extra docs about using EclipseLink [polaris]
Posted by "eric-maynard (via GitHub)" <gi...@apache.org>.
eric-maynard commented on code in PR #195:
URL: https://github.com/apache/polaris/pull/195#discussion_r1731543724
##########
docs/configuring-polaris-for-production.md:
##########
@@ -55,6 +55,13 @@ Be sure to secure your metastore backend since it will be storing credentials an
To use [EclipseLink](https://eclipse.dev/eclipselink/) for metastore management, specify the configuration `metaStoreManager.conf-file` to point to an [EclipseLink `persistence.xml` file](https://eclipse.dev/eclipselink/documentation/2.5/solutions/testingjpa002.htm). This file, local to the Polaris service, will contain information on what database to use for metastore management and how to connect to it.
+> [!IMPORTANT]
+> To use [EclipseLink](https://eclipse.dev/eclipselink), you need to ensure that you have done two things:
+> 1. Build the jar for the EclipseLink extension
+> 2. Set the property on the Polaris project to include eclipseLink.
+>
+> This can be achieved by setting `eclipseLink=true` in the `gradle.properties` file, or by passing the property explicitly while building all jars, e.g.: `./gradlew -PeclipseLink=true clean assemble`
Review Comment:
style: JAR is an acronym. It's used above, too.
--
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: commits-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add extra docs about using EclipseLink [polaris]
Posted by "danielvdende (via GitHub)" <gi...@apache.org>.
danielvdende commented on code in PR #195:
URL: https://github.com/apache/polaris/pull/195#discussion_r1730771302
##########
docs/configuring-polaris-for-production.md:
##########
@@ -55,6 +55,13 @@ Be sure to secure your metastore backend since it will be storing credentials an
To use [EclipseLink](https://eclipse.dev/eclipselink/) for metastore management, specify the configuration `metaStoreManager.conf-file` to point to an [EclipseLink `persistence.xml` file](https://eclipse.dev/eclipselink/documentation/2.5/solutions/testingjpa002.htm). This file, local to the Polaris service, will contain information on what database to use for metastore management and how to connect to it.
+> [!IMPORTANT]
+> To use [EclipseLink](https://eclipse.dev/eclipselink), you need to ensure that you have done two things:
+> 1. Build the jar for the EclipseLink extension
+> 2. Set the property on the Polaris project to include eclipseLink.
+>
+> This can be achieved by setting `eclipseLink=true` in the `gradle.properties` file, or by passing the property explicitly while building all jars, e.g.: `./gradlew -PeclipseLink=true clean assemble`
+
Review Comment:
That makes sense. I added it here because this is where I found myself looking for more information. Do you have any pointers/ideas on where it would fit better?
--
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: commits-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add extra docs about using EclipseLink [polaris]
Posted by "RussellSpitzer (via GitHub)" <gi...@apache.org>.
RussellSpitzer commented on code in PR #195:
URL: https://github.com/apache/polaris/pull/195#discussion_r1733945789
##########
docs/configuring-polaris-for-production.md:
##########
@@ -55,6 +55,13 @@ Be sure to secure your metastore backend since it will be storing credentials an
To use [EclipseLink](https://eclipse.dev/eclipselink/) for metastore management, specify the configuration `metaStoreManager.conf-file` to point to an [EclipseLink `persistence.xml` file](https://eclipse.dev/eclipselink/documentation/2.5/solutions/testingjpa002.htm). This file, local to the Polaris service, will contain information on what database to use for metastore management and how to connect to it.
+> [!IMPORTANT]
+> To use EclipseLink, you need to ensure that you have done two things:
Review Comment:
A few nits,
Avoid "you" -
```
EclipseLink requires:
1. Building the jar for the EclipseLink extension
2. Setting the `eclipseLink` gradle property to true within the Polaris build.
```
Or Something like that
--
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: commits-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add extra docs about using EclipseLink [polaris]
Posted by "eric-maynard (via GitHub)" <gi...@apache.org>.
eric-maynard commented on code in PR #195:
URL: https://github.com/apache/polaris/pull/195#discussion_r1731542406
##########
docs/configuring-polaris-for-production.md:
##########
@@ -55,6 +55,13 @@ Be sure to secure your metastore backend since it will be storing credentials an
To use [EclipseLink](https://eclipse.dev/eclipselink/) for metastore management, specify the configuration `metaStoreManager.conf-file` to point to an [EclipseLink `persistence.xml` file](https://eclipse.dev/eclipselink/documentation/2.5/solutions/testingjpa002.htm). This file, local to the Polaris service, will contain information on what database to use for metastore management and how to connect to it.
+> [!IMPORTANT]
+> To use [EclipseLink](https://eclipse.dev/eclipselink), you need to ensure that you have done two things:
Review Comment:
EclipseLink is already linked above, so let's not link it here.
##########
docs/configuring-polaris-for-production.md:
##########
@@ -55,6 +55,13 @@ Be sure to secure your metastore backend since it will be storing credentials an
To use [EclipseLink](https://eclipse.dev/eclipselink/) for metastore management, specify the configuration `metaStoreManager.conf-file` to point to an [EclipseLink `persistence.xml` file](https://eclipse.dev/eclipselink/documentation/2.5/solutions/testingjpa002.htm). This file, local to the Polaris service, will contain information on what database to use for metastore management and how to connect to it.
+> [!IMPORTANT]
+> To use [EclipseLink](https://eclipse.dev/eclipselink), you need to ensure that you have done two things:
+> 1. Build the jar for the EclipseLink extension
Review Comment:
style: To match the tense of the above line, this should be `Built` not `Build`
--
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: commits-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add extra docs about using EclipseLink [polaris]
Posted by "eric-maynard (via GitHub)" <gi...@apache.org>.
eric-maynard commented on code in PR #195:
URL: https://github.com/apache/polaris/pull/195#discussion_r1729237518
##########
docs/configuring-polaris-for-production.md:
##########
@@ -55,6 +55,13 @@ Be sure to secure your metastore backend since it will be storing credentials an
To use [EclipseLink](https://eclipse.dev/eclipselink/) for metastore management, specify the configuration `metaStoreManager.conf-file` to point to an [EclipseLink `persistence.xml` file](https://eclipse.dev/eclipselink/documentation/2.5/solutions/testingjpa002.htm). This file, local to the Polaris service, will contain information on what database to use for metastore management and how to connect to it.
+> [!IMPORTANT]
+> To use [EclipseLink](https://eclipse.dev/eclipselink), you need to ensure that you have done two things:
+> 1. Build the jar for the EclipseLink extension
+> 2. Set the property on the Polaris project to include eclipseLink.
+>
+> This can be achieved by setting `eclipseLink=true` in the `gradle.properties` file, or by passing the property explicitly while building all jars, e.g.: `./gradlew -PeclipseLink=true clean assemble`
+
Review Comment:
I think we need something like this for sure. But I don't think this is really connected to _configuring_ Polaris, but building it. Maybe there's a better place for this, or a new doc we need to write?
--
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: commits-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add extra docs about using EclipseLink [polaris]
Posted by "danielvdende (via GitHub)" <gi...@apache.org>.
danielvdende commented on code in PR #195:
URL: https://github.com/apache/polaris/pull/195#discussion_r1732252984
##########
docs/configuring-polaris-for-production.md:
##########
@@ -55,6 +55,13 @@ Be sure to secure your metastore backend since it will be storing credentials an
To use [EclipseLink](https://eclipse.dev/eclipselink/) for metastore management, specify the configuration `metaStoreManager.conf-file` to point to an [EclipseLink `persistence.xml` file](https://eclipse.dev/eclipselink/documentation/2.5/solutions/testingjpa002.htm). This file, local to the Polaris service, will contain information on what database to use for metastore management and how to connect to it.
+> [!IMPORTANT]
+> To use [EclipseLink](https://eclipse.dev/eclipselink), you need to ensure that you have done two things:
+> 1. Build the jar for the EclipseLink extension
+> 2. Set the property on the Polaris project to include eclipseLink.
+>
+> This can be achieved by setting `eclipseLink=true` in the `gradle.properties` file, or by passing the property explicitly while building all jars, e.g.: `./gradlew -PeclipseLink=true clean assemble`
+
Review Comment:
Thanks @eric-maynard. I've made the changes as per your comments.
--
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: commits-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add extra docs about using EclipseLink [polaris]
Posted by "danielvdende (via GitHub)" <gi...@apache.org>.
danielvdende commented on code in PR #195:
URL: https://github.com/apache/polaris/pull/195#discussion_r1738733432
##########
docs/configuring-polaris-for-production.md:
##########
@@ -55,6 +55,13 @@ Be sure to secure your metastore backend since it will be storing credentials an
To use [EclipseLink](https://eclipse.dev/eclipselink/) for metastore management, specify the configuration `metaStoreManager.conf-file` to point to an [EclipseLink `persistence.xml` file](https://eclipse.dev/eclipselink/documentation/2.5/solutions/testingjpa002.htm). This file, local to the Polaris service, will contain information on what database to use for metastore management and how to connect to it.
+> [!IMPORTANT]
+> To use EclipseLink, you need to ensure that you have done two things:
Review Comment:
Done!
--
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: commits-unsubscribe@polaris.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org