Package: google-datacatalog-postgresql-connector
google-datacatalog-postgresql-connectorLibrary for ingesting PostgreSQL metadata into Google Cloud Data Catalog.Disclaimer: This is not an officially supported Google product.Table of Contents1. Installation1.1. Mac/Linux1.2. Windows1.3. Install from source1.3.1. Get the code1.3.2. Create and activate avirtualenv1.3.3. Install the library2. Environment setup2.1. Auth credentials2.1.1. Create a service account and grant it below roles2.1.2. Download a JSON key and save it as2.2. Set environment variables3. Adapt user configurations4. Run entry point4.1. Run Python entry point4.2. Run the Python entry point with a user-defined entry resource URL prefix4.3. Run Docker entry point5. Scripts inside tools5.1. Run clean up5.2. Extract CSV6. Developer environment6.1. Install and run Yapf formatter6.2. Install and run Flake8 linter6.3. Run Tests7. Metrics8. Troubleshooting1. InstallationInstall this library in avirtualenvusing pip.virtualenvis a tool to
create isolated Python environments. The basic problem it addresses is one of
dependencies and versions, and indirectly permissions.Withvirtualenv, it's possible to install this library without needing system
install permissions, and without clashing with the installed system
dependencies. Make sure you use Python 3.6+.1.1. Mac/Linuxpip3installvirtualenv
virtualenv--pythonpython3.6<your-env>source<your-env>/bin/activate
<your-env>/bin/pipinstallgoogle-datacatalog-postgresql-connector1.2. Windowspip3installvirtualenv
virtualenv--pythonpython3.6<your-env>
<your-env>\Scripts\activate
<your-env>\Scripts\pip.exeinstallgoogle-datacatalog-postgresql-connector1.3. Install from source1.3.1. Get the codegitclonehttps://github.com/GoogleCloudPlatform/datacatalog-connectors-rdbms/cddatacatalog-connectors-rdbms/google-datacatalog-postgresql-connector1.3.2. Create and activate avirtualenvpip3installvirtualenv
virtualenv--pythonpython3.6<your-env>source<your-env>/bin/activate1.3.3. Install the librarypipinstall.2. Environment setup2.1. Auth credentials2.1.1. Create a service account and grant it below rolesData Catalog Admin2.1.2. Download a JSON key and save it as<YOUR-CREDENTIALS_FILES_FOLDER>/postgresql2dc-credentials.jsonPlease notice this folder and file will be required in next steps.2.2. Set environment variablesReplace below values according to your environment:exportGOOGLE_APPLICATION_CREDENTIALS=data_catalog_credentials_fileexportPOSTGRESQL2DC_DATACATALOG_PROJECT_ID=google_cloud_project_idexportPOSTGRESQL2DC_DATACATALOG_LOCATION_ID=google_cloud_location_idexportPOSTGRESQL2DC_POSTGRESQL_SERVER=postgresql_serverexportPOSTGRESQL2DC_POSTGRESQL_USERNAME=postgresql_usernameexportPOSTGRESQL2DC_POSTGRESQL_PASSWORD=postgresql_passwordexportPOSTGRESQL2DC_POSTGRESQL_DATABASE=postgresql_databaseexportPOSTGRESQL2DC_RAW_METADATA_CSV=postgresql_raw_csv(IfsuppliedignoresthePOSTGRESQLservercredentials)3. Adapt user configurationsAlong with default metadata, the connector can ingest optional metadata as well, such as number of
rows in each table. The table below shows what metadata is scraped by default, and what is configurable.MetadataDescriptionScraped by defaultConfig optionschema_nameName of a schemaY---table_nameName of a tableY---table_typeType of a table (BASE, VIEW, etc)Y---table_size_mbSize of a table, in MBY---column_nameName of a columnY---column_typeType of a column (ARRAY, USER-DEFINED, etc)Y---column_default_valueDefault value of a columnY---column_nullableWhether a column is nullableY---column_char_lengthChar length of values in a columnY---column_numeric_precisionNumeric precision of values in a columnY---column_enum_valuesList of enum values for a columnY---ANALYZE statementStatement to refresh metadata informationNrefresh_metadata_tablestable_rowsNumber of rows in a tableNsync_row_countsbase_metadata_query_filenameOverrides the base metadata query file nameN/Abase_metadata_query_filenameSample configuration fileingest_cfg.yamlin the repository root shows what kind of configuration is expected.If you want to run optional queries, please add ingest_cfg.yaml to your working directory and adapt it to your needs.4. Run entry point4.1. Run Python entry pointVirtualenvgoogle-datacatalog-postgresql-connector\--datacatalog-project-id=$POSTGRESQL2DC_DATACATALOG_PROJECT_ID\--datacatalog-location-id=$POSTGRESQL2DC_DATACATALOG_LOCATION_ID\--postgresql-host=$POSTGRESQL2DC_POSTGRESQL_SERVER\--postgresql-user=$POSTGRESQL2DC_POSTGRESQL_USERNAME\--postgresql-pass=$POSTGRESQL2DC_POSTGRESQL_PASSWORD\--postgresql-database=$POSTGRESQL2DC_POSTGRESQL_DATABASE\--raw-metadata-csv=$POSTGRESQL2DC_RAW_METADATA_CSV4.2. Run the Python entry point with a user-defined entry resource URL prefixThis option is useful when the connector cannot accurately determine the database hostname.
For example when running under proxies, load balancers or database read replicas,
you can specify the prefix of your master instance so the resource URL will point
to the exact database where the data is stored.Virtualenvgoogle-datacatalog-postgresql-connector\--datacatalog-project-id=$POSTGRESQL2DC_DATACATALOG_PROJECT_ID\--datacatalog-location-id=$POSTGRESQL2DC_DATACATALOG_LOCATION_ID\--datacatalog-entry-resource-url-prefixproject/database-instance\--postgresql-host=$POSTGRESQL2DC_POSTGRESQL_SERVER\--postgresql-user=$POSTGRESQL2DC_POSTGRESQL_USERNAME\--postgresql-pass=$POSTGRESQL2DC_POSTGRESQL_PASSWORD\--postgresql-database=$POSTGRESQL2DC_POSTGRESQL_DATABASE\--raw-metadata-csv=$POSTGRESQL2DC_RAW_METADATA_CSV4.3. Run Docker entry pointdockerbuild-tpostgresql2datacatalog.
dockerrun--rm--tty-vYOUR-CREDENTIALS_FILES_FOLDER:/datapostgresql2datacatalog\--datacatalog-project-id=$POSTGRESQL2DC_DATACATALOG_PROJECT_ID\--datacatalog-location-id=$POSTGRESQL2DC_DATACATALOG_LOCATION_ID\--postgresql-host=$POSTGRESQL2DC_POSTGRESQL_SERVER\--postgresql-user=$POSTGRESQL2DC_POSTGRESQL_USERNAME\--postgresql-pass=$POSTGRESQL2DC_POSTGRESQL_PASSWORD\--postgresql-database=$POSTGRESQL2DC_POSTGRESQL_DATABASE\--raw-metadata-csv=$POSTGRESQL2DC_RAW_METADATA_CSV5. Scripts inside tools5.1. Run clean up# List of projects split by comma. Can be a single value without commaexportPOSTGRESQL2DC_DATACATALOG_PROJECT_IDS=my-project-1,my-project-2# Run the clean uppythontools/cleanup_datacatalog.py--datacatalog-project-ids=$POSTGRESQL2DC_DATACATALOG_PROJECT_IDS5.2. Extract CSV# Run  inside your postgresql database instanceCOPY(selectt.table_schemaasschema_name,t.table_name,t.table_type,c.column_name,c.column_defaultascolumn_default_value,c.is_nullableascolumn_nullable,c.data_typeascolumn_type,c.character_maximum_lengthascolumn_char_length,c.numeric_precisionascolumn_numeric_precisionfrominformation_schema.tablestjoininformation_schema.columnsconc.table_name=t.table_namewheret.table_schemanotin('pg_catalog','information_schema','pg_toast','gp_toolkit')andc.table_schemanotin('pg_catalog','information_schema','pg_toast','gp_toolkit'))TO'/home/postgre/postgresql_full_dump.csv'CSVHEADER;6. Developer environment6.1. Install and run Yapf formatterpipinstall--upgradeyapf# Auto update filesyapf--in-place--recursivesrctests# Show diffyapf--diff--recursivesrctests# Set up pre-commit hook# From the root of your git project.curl-opre-commit.shhttps://raw.githubusercontent.com/google/yapf/master/plugins/pre-commit.sh
chmoda+xpre-commit.sh
mvpre-commit.sh.git/hooks/pre-commit6.2. Install and run Flake8 linterpipinstall--upgradeflake8
flake8srctests6.3. Run Testspythonsetup.pytest7. MetricsMetrics README.md8. TroubleshootingIn the case a connector execution hits Data Catalog quota limit, an error will be raised and logged with the following detailement, depending on the performed operation READ/WRITE/SEARCH:status = StatusCode.RESOURCE_EXHAUSTED
details = "Quota exceeded for quota metric 'Read requests' and limit 'Read requests per minute' of service 'datacatalog.googleapis.com' for consumer 'project_number:1111111111111'."
debug_error_string = 
"{"created":"@1587396969.506556000", "description":"Error received from peer ipv4:172.217.29.42:443","file":"src/core/lib/surface/call.cc","file_line":1056,"grpc_message":"Quota exceeded for quota metric 'Read requests' and limit 'Read requests per minute' of service 'datacatalog.googleapis.com' for consumer 'project_number:1111111111111'.","grpc_status":8}"For more info about Data Catalog quota, go to:Data Catalog quota docs.