BigQuery
Connecting to BigQuery
For an overview of the connector, please refer to the following link.
Create a Connector
Select the “Connectors” tab on the top page and press the “Create” button.
Enter BigQuery Credentials
BigQuery offers two authentication methods.
Connecting with Service Account
Select BigQuery (Service Account) and enter the credentials in the displayed form.
Field Name | Description | Required | Example |
---|---|---|---|
Credential | Service Account JSON | ✅ | {"project_id": "", ...} |
For creating a service account, please refer to the official page.
Connecting with OAuth
Select BigQuery (OAuth) and press the displayed sign-in button to authenticate with Google.
The following fields are also required.
Field Name | Description | Required | Example |
---|---|---|---|
Project ID | Project ID | ✅ | demo-project |
Dataset | Dataset Name | demo_dataset | |
Location | Location | asia-northeast1 |
After entering the information, press the Create button to complete the creation. If there are any errors, please check the connection details again.
Connect to the Created Database
Once created successfully, you can retrieve the connector name from the list. The string next to the icon is connection_name
. You can use this to connect to the database in your code.
Enter the created connector name in SQL or Python code to retrieve data.
Create a Connector
Select the “Connectors” tab on the top page and press the “Create” button.
Enter BigQuery Credentials
BigQuery offers two authentication methods.
Connecting with Service Account
Select BigQuery (Service Account) and enter the credentials in the displayed form.
Field Name | Description | Required | Example |
---|---|---|---|
Credential | Service Account JSON | ✅ | {"project_id": "", ...} |
For creating a service account, please refer to the official page.
Connecting with OAuth
Select BigQuery (OAuth) and press the displayed sign-in button to authenticate with Google.
The following fields are also required.
Field Name | Description | Required | Example |
---|---|---|---|
Project ID | Project ID | ✅ | demo-project |
Dataset | Dataset Name | demo_dataset | |
Location | Location | asia-northeast1 |
After entering the information, press the Create button to complete the creation. If there are any errors, please check the connection details again.
Connect to the Created Database
Once created successfully, you can retrieve the connector name from the list. The string next to the icon is connection_name
. You can use this to connect to the database in your code.
Enter the created connector name in SQL or Python code to retrieve data.
~/.morph/connections.yml
.Run the morph init Command
Run the morph init
command to save the DB connection information to ~/.morph/connections.yml
.
If you have not installed the morph package, please install it with the following command before proceeding.
A list of database types will be displayed in the interactive interface, select Snowflake (User/Password).
Next, enter the credentials. slug
is treated as the connector name, which you specify in SQL or Python.
Replace the following input examples with actual values that can connect.
Once the credentials are saved, the following message will be displayed.
connections.yml
is saved as follows. If other connectors are created, they will be added under connections
.
Retrieve Data Using the Connector in Code
Enter the created connector name in SQL or Python code to retrieve data.
When actually specifying the connector and executing the file, the priority is as follows.
Also, please note that only connectors created in the dashboard can be used in the environment where morph deploy
is performed.
- Connectors listed in
~/.morph/connections.yml
on the local machine - Connectors registered in the cloud
How to Write for OAuth
When using OAuth, directly edit ~/.morph/connections.yml
.
Refreshing the access token is a dashboard feature, so the one described will always be used in the local environment.
OAuth Method