Refactor Postgres Field Transformers and Collections #236
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| package org.hypertrace.core.documentstore.postgres; | ||
|
|
||
| import org.hypertrace.core.documentstore.CloseableIterator; | ||
| import org.hypertrace.core.documentstore.Document; | ||
| import org.hypertrace.core.documentstore.model.options.QueryOptions; | ||
| import org.hypertrace.core.documentstore.postgres.query.v1.PostgresQueryParser; | ||
| import org.hypertrace.core.documentstore.query.Query; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * PostgreSQL collection implementation for flat documents. All fields are stored as top-level | ||
| * PostgreSQL columns. | ||
| */ | ||
| public class FlatPostgresCollection extends PostgresCollection { | ||
|
|
||
| private static final Logger LOGGER = LoggerFactory.getLogger(FlatPostgresCollection.class); | ||
|
|
||
| FlatPostgresCollection(final PostgresClient client, final String collectionName) { | ||
| super(client, collectionName); | ||
| } | ||
|
|
||
| @Override | ||
| public CloseableIterator<Document> query( | ||
| final org.hypertrace.core.documentstore.query.Query query, final QueryOptions queryOptions) { | ||
| PostgresQueryParser queryParser = createParser(query); | ||
| return queryWithParser(query, queryParser); | ||
| } | ||
|
|
||
| @Override | ||
| public CloseableIterator<Document> find( | ||
| final org.hypertrace.core.documentstore.query.Query query) { | ||
| PostgresQueryParser queryParser = createParser(query); | ||
| return queryWithParser(query, queryParser); | ||
| } | ||
|
|
||
| @Override | ||
| public long count( | ||
| org.hypertrace.core.documentstore.query.Query query, QueryOptions queryOptions) { | ||
| PostgresQueryParser queryParser = new PostgresQueryParser(tableIdentifier, query); | ||
| return countWithParser(query, queryParser); | ||
| } | ||
|
|
||
| private PostgresQueryParser createParser(Query query) { | ||
| return new PostgresQueryParser(tableIdentifier, PostgresQueryExecutor.transformAndLog(query)); | ||
|
||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| package org.hypertrace.core.documentstore.postgres; | ||
|
|
||
| import org.hypertrace.core.documentstore.CloseableIterator; | ||
| import org.hypertrace.core.documentstore.Document; | ||
| import org.hypertrace.core.documentstore.model.options.QueryOptions; | ||
| import org.hypertrace.core.documentstore.postgres.query.v1.PostgresQueryParser; | ||
| import org.hypertrace.core.documentstore.postgres.query.v1.transformer.NestedPostgresColTransformer; | ||
| import org.hypertrace.core.documentstore.query.Query; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * PostgreSQL collection implementation for legacy document storage mode. Fields are stored within | ||
| * JSONB columns. | ||
| */ | ||
| public class NestedPostgresCollection extends PostgresCollection { | ||
|
|
||
| private static final Logger LOGGER = LoggerFactory.getLogger(NestedPostgresCollection.class); | ||
|
|
||
| NestedPostgresCollection(final PostgresClient client, final String collectionName) { | ||
| super(client, collectionName); | ||
| } | ||
|
|
||
| @Override | ||
| public CloseableIterator<Document> query( | ||
| final org.hypertrace.core.documentstore.query.Query query, final QueryOptions queryOptions) { | ||
| PostgresQueryParser queryParser = createParser(query); | ||
| return queryWithParser(query, queryParser); | ||
| } | ||
|
|
||
| @Override | ||
| public CloseableIterator<Document> find( | ||
| final org.hypertrace.core.documentstore.query.Query query) { | ||
| PostgresQueryParser queryParser = createParser(query); | ||
| return queryWithParser(query, queryParser); | ||
| } | ||
|
|
||
| @Override | ||
| public long count( | ||
| org.hypertrace.core.documentstore.query.Query query, QueryOptions queryOptions) { | ||
| PostgresQueryParser queryParser = createParser(query); | ||
| return countWithParser(query, queryParser); | ||
| } | ||
|
|
||
| private PostgresQueryParser createParser(Query query) { | ||
| return new PostgresQueryParser( | ||
| tableIdentifier, | ||
| PostgresQueryExecutor.transformAndLog(query), | ||
| new NestedPostgresColTransformer()); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you please add comment on other methods as well.
for eg: what would be the behavior of getCollection(), createCollection()
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do not see a corresponding implementation change in MongoDatastore.
If we upgrade document-store in entity-service, is the expectation that we would getCollection for mongodb collection and getCollectionForType for postgres collection?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1
How is this supposed to be used by the clients/consumers?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's the expectation right now, yes. Now that I think of it, a better approach would be to perhaps, for Mongo, to return an instance of
MongoCollectionfor typeNESTEDand anIllegalArgumentExceptionotherwise.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@suresh-prakash This API is intended to be primarily used for SQL datastores like PG in which we can store both flat and nested documents. For Mongo, since we only support nested, it'll throw an
IllegalArgumentExceptionforFLATdoc types (as per this PR).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe, I am a bit confused here still. The consumers are the ones who are choosing which of the Postgres FLAT/NESTED to use. So, why would the clients again ask the library which one is being used. I mean, the clients would already have this information with them, right?