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

Destination Snowflake: update check method to verify permissions for staging #8781

Merged

Conversation

VitaliiMaltsev
Copy link
Contributor

@VitaliiMaltsev VitaliiMaltsev commented Dec 14, 2021

What

  1. User must have permissions on Snowflake role to create/drop stage
  2. Acceptance tests failed after migration on jdk 17
    Error logs
    net.snowflake.client.jdbc.SnowflakeSQLLoggedException: JDBC driver internal error: Fail to retrieve row count for first arrow chunk: null.
        at app//net.snowflake.client.jdbc.SnowflakeResultSetSerializableV1.setFirstChunkRowCountForArrow(SnowflakeResultSetSerializableV1.java:1011)
        at app//net.snowflake.client.jdbc.SnowflakeResultSetSerializableV1.create(SnowflakeResultSetSerializableV1.java:504)
        at app//net.snowflake.client.core.SFResultSetFactory.getResultSet(SFResultSetFactory.java:28)
        at app//net.snowflake.client.core.SFStatement.executeQueryInternal(SFStatement.java:251)
        at app//net.snowflake.client.core.SFStatement.executeQuery(SFStatement.java:167)
        at app//net.snowflake.client.core.SFStatement.execute(SFStatement.java:749)
        at app//net.snowflake.client.jdbc.SnowflakeStatementV1.executeQueryInternal(SnowflakeStatementV1.java:245)
        at app//net.snowflake.client.jdbc.SnowflakeStatementV1.executeQuery(SnowflakeStatementV1.java:149)
       

How

  1. Run the connection check before every sync to catch missing privileges before running
  2. Add property JDBC_QUERY_RESULT_FORMAT = JSON into jdbc connection url

Recommended reading order

  1. x.java
  2. y.python

🚨 User Impact 🚨

This should have no visible 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
  • Credentials added to Github CI. 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
  • Credentials added to Github CI. 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.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


vmaltsev seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions github-actions bot added the area/connectors Connector related issues label Dec 14, 2021
@VitaliiMaltsev VitaliiMaltsev temporarily deployed to more-secrets December 14, 2021 14:00 Inactive
@VitaliiMaltsev
Copy link
Contributor Author

VitaliiMaltsev commented Dec 14, 2021

/test connector=connectors/destination-snowflake

🕑 connectors/destination-snowflake https://github.com/airbytehq/airbyte/actions/runs/1578179292
❌ connectors/destination-snowflake https://github.com/airbytehq/airbyte/actions/runs/1578179292
🐛

@jrhizor jrhizor temporarily deployed to more-secrets December 14, 2021 14:03 Inactive
@VitaliiMaltsev VitaliiMaltsev temporarily deployed to more-secrets December 14, 2021 18:06 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets December 14, 2021 18:17 Inactive
@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Dec 15, 2021
@VitaliiMaltsev VitaliiMaltsev temporarily deployed to more-secrets December 15, 2021 08:48 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets December 15, 2021 08:49 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets December 15, 2021 09:00 Inactive
@VitaliiMaltsev VitaliiMaltsev temporarily deployed to more-secrets December 15, 2021 09:26 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets December 15, 2021 09:29 Inactive
@VitaliiMaltsev
Copy link
Contributor Author

VitaliiMaltsev commented Dec 15, 2021

/test connector=connectors/destination-snowflake

🕑 connectors/destination-snowflake https://github.com/airbytehq/airbyte/actions/runs/1582055524
✅ connectors/destination-snowflake https://github.com/airbytehq/airbyte/actions/runs/1582055524
Python tests coverage:

	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                                              Stmts   Miss  Cover
	 -------------------------------------------------------------------------------------
	 main_dev_transform_catalog.py                                         3      3     0%
	 main_dev_transform_config.py                                          3      3     0%
	 normalization/__init__.py                                             4      0   100%
	 normalization/destination_type.py                                    13      0   100%
	 normalization/transform_catalog/__init__.py                           2      0   100%
	 normalization/transform_catalog/catalog_processor.py                143     77    46%
	 normalization/transform_catalog/destination_name_transformer.py     124      6    95%
	 normalization/transform_catalog/reserved_keywords.py                 13      0   100%
	 normalization/transform_catalog/stream_processor.py                 494    313    37%
	 normalization/transform_catalog/table_name_registry.py              174     34    80%
	 normalization/transform_catalog/transform.py                         45     26    42%
	 normalization/transform_catalog/utils.py                             33      7    79%
	 normalization/transform_config/__init__.py                            2      0   100%
	 normalization/transform_config/transform.py                         146     32    78%
	 -------------------------------------------------------------------------------------
	 TOTAL                                                              1199    501    58%

@VitaliiMaltsev VitaliiMaltsev temporarily deployed to more-secrets December 15, 2021 09:32 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets December 15, 2021 09:34 Inactive
@VitaliiMaltsev VitaliiMaltsev temporarily deployed to more-secrets December 15, 2021 10:47 Inactive
@@ -152,6 +152,8 @@ By default, Airbyte uses batches of `INSERT` commands to add data to a temporary

Internal named stages are storage location objects within a Snowflake database/schema. Because they are database objects, the same security permissions apply as with any other database objects. No need to provide additional properties for internal staging

**Operating on a stage also requires the USAGE privilege on the parent database and schema.**
Copy link
Contributor

Choose a reason for hiding this comment

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

can you add it to the script above used to create the user?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

the script above already has needed statement
grant OWNERSHIP
on database identifier($airbyte_database)
to role identifier($airbyte_role);

@VitaliiMaltsev
Copy link
Contributor Author

VitaliiMaltsev commented Dec 16, 2021

/publish connector=connectors/destination-snowflake

🕑 connectors/destination-snowflake https://github.com/airbytehq/airbyte/actions/runs/1586620263
✅ connectors/destination-snowflake https://github.com/airbytehq/airbyte/actions/runs/1586620263

@VitaliiMaltsev VitaliiMaltsev temporarily deployed to more-secrets December 16, 2021 08:51 Inactive
@jrhizor jrhizor temporarily deployed to more-secrets December 16, 2021 08:53 Inactive
@VitaliiMaltsev VitaliiMaltsev merged commit 91513f5 into master Dec 16, 2021
@VitaliiMaltsev VitaliiMaltsev deleted the vmaltsev/destination-snowflake-check_stage-permissions branch December 16, 2021 10:01
schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
…staging (airbytehq#8781)

* Destination Snowflake update check method to verify permission for stages

* fix for jdk 17

* fix for jdk 17

* fix with ci secrets

* fix with ci secrets

* removed snowflake secrets from ci_credentials.sh

* bump version

Co-authored-by: vmaltsev <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants