🎉 BigQuery destination mlp #11238

andriikorotkov · 2022-03-17T16:31:45Z

What

Updated spec and documentation according to MLP document

How

🚨 User Impact 🚨

No impact

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

Community member? Grant edit access to maintainers (instructions)
Secrets in the connector's spec are annotated with airbyte_secret
Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
Code reviews completed
Documentation updated
- Connector's README.md
- Connector's bootstrap.md. See description and examples
- docs/SUMMARY.md
- docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
- docs/integrations/README.md
- airbyte-integrations/builds.md
PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
If new credentials are required for use in CI, add them to GSM. Instructions.
/test connector=connectors/<name> command is passing
New Connector version released on Dockerhub by running the /publish command described here
After the connector is published, connector added to connector index as described here
Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Updating a connector

Community member or Airbyter

Grant edit access to maintainers (instructions)
Secrets in the connector's spec are annotated with airbyte_secret
Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
Code reviews completed
Documentation updated
- Connector's README.md
- Connector's bootstrap.md. See description and examples
- Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
If new credentials are required for use in CI, add them to GSM. Instructions.
/test connector=connectors/<name> command is passing
New Connector version released on Dockerhub by running the /publish command described here
After the new connector version is published, connector version bumped in the seed directory as described here
Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Connector Generator

Issue acceptance criteria met
PR name follows PR naming conventions
If adding a new generator, add it to the list of scaffold modules being tested
The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
Documentation which references the generator is updated as needed

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

andriikorotkov · 2022-03-17T17:25:09Z

@misteryeo, I edited the spec and documentation, but there are a few issues that I don't quite understand. Please help me to understand a little deeper.

Since this warning is in place, is there a way in the UI for us to lock this down after the destination has been created? https://share.getcloudapp.com/8LuDG6Gm - Unfortunately, this is static text that we added as a description to a specific field, and we can't change it dynamically.
Can we surface BigQuery docs that describe what each field is and where to find that particular field and include that in the field description? - I have added a link to both our and the PSI documentation to the specification in some fields, which may be the biggest problem. But for clear fields, such as "Bucket Name" or "Bucket Path", I did not add a link. There is a rather detailed description for them, and a description with links in our documentation. Will that be enough?

misteryeo · 2022-03-18T15:19:48Z

@timroes on (1) - is this possible?

@andriikorotkov Let's still pull links to docs for those fields - we don't want to assume that everyone is technical in Cloud. Simply adding "Read more here." and linking docs is sufficient. Thanks!

timroes · 2022-03-18T15:22:04Z

@misteryeo I am not aware that we'd have any mechanism for this. But I'll pull in @sherifnada for this: Do you know of any way in our spec to define that a field is "setup only" and should not be changeable after creation anymore?

sherifnada · 2022-03-18T16:40:35Z

@timroes there isn’t a way to describe that a field is immutable.

andriikorotkov · 2022-03-18T16:54:40Z

@sherifnada, @misteryeo I found another small bug in the specs. When we have a field of type "oneOf", it is not marked with an asterisk as required, although it is present in the array "required". I will create a followup ticket to fix this.

…bigquery_mlp

andriikorotkov · 2022-03-18T21:14:41Z