Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: partial metadata projection #1258

Merged
merged 6 commits into from
Aug 15, 2023
Merged

Conversation

loferris
Copy link
Contributor

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

This PR updates the documentation to specify how to get a partial metadata projection via the table.get() method, and clarified the difference between this method and table.getMetadata() in terms of being selective about metadata retrieved. A system test for this usage of table.get() has been added, as well as an expansion of the table.getMetadata() system test to help illustrate the differences between these two methods. This PR reflects an update to the BigQuery API across all languages, not a GH issue for this repo.

@loferris loferris requested review from a team as code owners August 11, 2023 02:26
@product-auto-label product-auto-label bot added size: s Pull request size is small. api: bigquery Issues related to the googleapis/nodejs-bigquery API. labels Aug 11, 2023
Copy link
Contributor

@alvarowolfx alvarowolfx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checking the implementation guide, I think a good idea to test the different between getting a basic view vs full view is to check for the lastModifiedTime and/or numBytes, as in the basic view, those attributes are not computed by the backend.

https://github.com/googleapis/google-cloud-go/pull/6186/files#diff-62ca20d473019007434974e167cb4ad4be57a9f5b8b4ba834dfcf7abe3ee4f76

@@ -888,9 +887,25 @@ describe('BigQuery', () => {
const description = 'catsandstuff';
await table.setMetadata({description});
const [metadata] = await table.getMetadata();
const metadataProps = Object.values(metadata);
assert.strictEqual(metadataProps.length, 18);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think checking for the number of attributes here can lead the test to be flaky in the long term, as every time that the service team adds a new field, the test is going to break.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point!

Object.keys(basicMetadata.metadata)
);

assert.strictEqual(basicMetadataProps.length, 10);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment around testing for the amount of fields

@alvarowolfx alvarowolfx changed the title Feat: partial metadata projection feat: partial metadata projection Aug 11, 2023
@loferris
Copy link
Contributor Author

Checking the implementation guide, I think a good idea to test the different between getting a basic view vs full view is to check for the lastModifiedTime and/or numBytes, as in the basic view, those attributes are not computed by the backend.

https://github.com/googleapis/google-cloud-go/pull/6186/files#diff-62ca20d473019007434974e167cb4ad4be57a9f5b8b4ba834dfcf7abe3ee4f76

I'm already checking against numBytes in the new system test so I can add lastModifiedTime as well.

@loferris loferris merged commit b70d3a4 into main Aug 15, 2023
16 checks passed
@loferris loferris deleted the feat_partial_metadata_projection branch August 15, 2023 17:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: bigquery Issues related to the googleapis/nodejs-bigquery API. size: s Pull request size is small.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants