dimas-b commented on code in PR #2728: URL: https://github.com/apache/polaris/pull/2728#discussion_r2437720564
########## persistence/nosql/nodes/README.md: ########## @@ -0,0 +1,34 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Uniquely identify running Polaris nodes + +Some ID generation mechanisms, +like [Snowflake-IDs](https://medium.com/@jitenderkmr/demystifying-snowflake-ids-a-unique-identifier-in-distributed-computing-72796a827c9d), +require unique integer IDs for each running node. This framework provides a mechanism to assign each running node a +unique integer ID. + +## Code structure + +The code is structured into multiple modules. Consuming code should almost always pull in only the API module. + +* `polaris-nodes-api` provides the necessary Java interfaces and immutable types. +* `polaris-nodes-impl` provides the storage agnostic implementation. +* `polaris-nodes-spi` provides the necessary interfaces to provide a storage specific implementation. Review Comment: That is a valid point :+1: I made a specific renaming proposal in the thread about the package name (above). -- 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]
