Skip to content

Commit

Permalink
[DOCS] Remove Instances of Test Connection from the GX Cloud Docs (#9815
Browse files Browse the repository at this point in the history
)
  • Loading branch information
kwcanuck committed Apr 30, 2024
1 parent c716838 commit ae54419
Show file tree
Hide file tree
Showing 8 changed files with 82 additions and 107 deletions.
28 changes: 12 additions & 16 deletions docs/docusaurus/docs/cloud/_try_gx_cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,11 @@ Create a Data Asset to define the data you want GX Cloud to access within Snowfl

5. Complete the following fields:

- **Username**: Enter the username you use to access Snowflake.

- **Account identifier**: Enter your Snowflake organization and account name separated by a hyphen (`oraganizationname-accountname`) or your account name and a legacy account locator separated by a period (`accountname.region`). The legacy account locator value must include the geographical region. For example, `us-east-1`.

To locate your Snowflake organization name, account name, or legacy account locator values see [Finding the Organization and Account Name for an Account](https://docs.snowflake.com/en/user-guide/admin-account-identifier#finding-the-organization-and-account-name-for-an-account) or [Using an Account Locator as an Identifier](https://docs.snowflake.com/en/user-guide/admin-account-identifier#using-an-account-locator-as-an-identifier).

- **Username**: Enter the username you use to access Snowflake.

- **Password**: Enter a Snowflake password. To improve data security, GX recommends using a Snowflake service account to connect to GX Cloud.

Expand All @@ -124,27 +124,25 @@ Create a Data Asset to define the data you want GX Cloud to access within Snowfl

- **Role**: Enter your Snowflake role.

6. Optional. Select **Test connection** to test the Data Source connection. Testing the connection to the Data Source is a preventative measure that makes sure the connection configuration is correct. This verification can help you avoid errors and can reduce troubleshooting downtime.

7. Click **Continue**.
6. Click **Connect**.

8. Select **Table Asset** or **Query Asset** and complete the following fields:
7. Select **Table Asset** or **Query Asset** and complete the following fields:

- **Table name**: When **Table Asset** is selected, enter a name for the table you're creating in the Data Asset.

- **Data Asset name**: Enter a name for the Data Asset. Data Asset names must be unique. If you use the same name for multiple Data Assets, each Data Asset must be associated with a unique Data Source.

- **Query**: When **Query Asset** is selected, enter the query that you want to run on the table.

9. Select the **Complete Asset** tab to provide all Data Asset records to your Expectations and validations, or select the **Batches** tab to use subsets of Data Asset records for your Expectations and validations. If you selected the **Batches** tab, complete the following fields:
8. Select the **Complete Asset** tab to provide all Data Asset records to your Expectations and validations, or select the **Batches** tab to use subsets of Data Asset records for your Expectations and validations. If you selected the **Batches** tab, complete the following fields:

- **Split Data Asset by** - Select **Year** to partition Data Asset records by year, select **Year - Month** to partition Data Asset records by year and month, or select **Year - Month - Day** to partition Data Asset records by year, month, and day.

- **Column of datetime type** - Enter the name of the column containing the date and time data.

10. Optional. Select **Add Data Asset** to add additional tables or queries and repeat steps 8 and 9.
9. Optional. Select **Add Data Asset** to add additional tables or queries and repeat steps 8 and 9.

11. Click **Finish**. The Data Asset(s), a default empty Expectation Suite, and a default Checkpoint are created.
10. Click **Finish**. The Data Asset(s), a default empty Expectation Suite, and a default Checkpoint are created.

</TabItem>
<TabItem value="PostgreSQL">
Expand All @@ -167,27 +165,25 @@ Define the data you want GX Cloud to access within PostgreSQL.

4. Enter a connection string in the **Connection string** field. The connection string format is `postgresql+psycopg2//YourUserName:YourPassword@YourHostname:5432/YourDatabaseName`.

5. Optional. Select **Test connection** to test the Data Source connection. Testing the connection to the Data Source is a preventative measure that makes sure the connection configuration is correct. This verification can help you avoid errors and can reduce troubleshooting downtime.

6. Click **Continue**.
5. Click **Connect**.

7. Select **Table Asset** or **Query Asset** and complete the following fields:
6. Select **Table Asset** or **Query Asset** and complete the following fields:

- **Table name**: When **Table Asset** is selected, enter a name for the table you're creating in the Data Asset.

- **Data Asset name**: Enter a name for the Data Asset. Data Asset names must be unique. If you use the same name for multiple Data Assets, each Data Asset must be associated with a unique Data Source.

- **Query**: When **Query Asset** is selected, enter the query that you want to run on the table.

8. Select the **Complete Asset** tab to provide all Data Asset records to your Expectations and validations, or select the **Batches** tab to use subsets of Data Asset records for your Expectations and validations. If you selected the **Batches** tab, complete the following fields:
7. Select the **Complete Asset** tab to provide all Data Asset records to your Expectations and validations, or select the **Batches** tab to use subsets of Data Asset records for your Expectations and validations. If you selected the **Batches** tab, complete the following fields:

- **Split Data Asset by** - Select **Year** to partition Data Asset records by year, select **Year - Month** to partition Data Asset records by year and month, or select **Year - Month - Day** to partition Data Asset records by year, month, and day.

- **Column of datetime type** - Enter the name of the column containing the date and time data.

9. Optional. Select **Add Data Asset** to add additional tables or queries and repeat steps 8 and 9.
8. Optional. Select **Add Data Asset** to add additional tables or queries and repeat steps 8 and 9.

10. Click **Finish**. The Data Asset(s), a default empty Expectation Suite, and a default Checkpoint are created.
9. Click **Finish**. The Data Asset(s), a default empty Expectation Suite, and a default Checkpoint are created.

</TabItem>
</Tabs>
Expand Down
14 changes: 6 additions & 8 deletions docs/docusaurus/docs/cloud/connect/connect_postgresql.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,27 +47,25 @@ To validate data stored in a PostgreSQL database from GX Cloud, you must add the

6. Enter a connection string in the **Connection string** field. The connection string format is `postgresql+psycopg2//YourUserName:YourPassword@YourHostname:5432/YourDatabaseName`.

7. Optional. Select **Test connection** to test the Data Source connection. Testing the connection to the Data Source is a preventative measure that makes sure the connection configuration is correct. This verification can help you avoid errors and can reduce troubleshooting downtime.
7. Click **Connect**.

8. Click **Continue**.

9. Select **Table Asset** or **Query Asset** and complete the following fields:
8. Select **Table Asset** or **Query Asset** and complete the following fields:

- **Table name**: When **Table Asset** is selected, enter the name of the Data Source table you're connecting to.

- **Data Asset name**: Enter a name for the Data Asset. Data Asset names must be unique across all Data Sources in GX Cloud.

- **Query**: When **Query Asset** is selected, enter the query that you want to run on the Data Asset.

10. Select the **Complete Asset** tab to provide all Data Asset records to your Expectations and validations, or select the **Batches** tab to use subsets of Data Asset records for your Expectations and validations. If you selected the **Batches** tab, complete the following fields:
9. Select the **Complete Asset** tab to provide all Data Asset records to your Expectations and validations, or select the **Batches** tab to use subsets of Data Asset records for your Expectations and validations. If you selected the **Batches** tab, complete the following fields:

- **Split Data Asset by** - Select **Year** to partition Data Asset records by year, select **Year - Month** to partition Data Asset records by year and month, or select **Year - Month - Day** to partition Data Asset records by year, month, and day.

- **Column of datetime type** - Enter the name of the column containing the date and time data.

11. Optional. Select **Add Data Asset** to add additional tables or queries and repeat steps 8 and 9.
10. Optional. Select **Add Data Asset** to add additional tables or queries and repeat steps 8 and 9.

12. Click **Finish**.
11. Click **Finish**.

13. Create an Expectation. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).
12. Create an Expectation. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).

20 changes: 9 additions & 11 deletions docs/docusaurus/docs/cloud/connect/connect_snowflake.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,11 @@ You can use an existing Snowflake warehouse, but GX recommends creating a separa

7. Complete the following fields:

- **Username**: Enter the username you use to access Snowflake.

- **Account identifier**: Enter your Snowflake organization and account name separated by a hyphen (`oraganizationname-accountname`) or your account name and a legacy account locator separated by a period (`accountname.region`). The legacy account locator value must include the geographical region. For example, `us-east-1`.
- **Account identifier**: Enter your Snowflake organization and account name separated by a hyphen (`oraganizationname-accountname`) or your account name and a legacy account locator separated by a period (`accountname.region`). The legacy account locator value must include the geographical region. For example, `us-east-1`.

To locate your Snowflake organization name, account name, or legacy account locator values see [Finding the Organization and Account Name for an Account](https://docs.snowflake.com/en/user-guide/admin-account-identifier#finding-the-organization-and-account-name-for-an-account) or [Using an Account Locator as an Identifier](https://docs.snowflake.com/en/user-guide/admin-account-identifier#using-an-account-locator-as-an-identifier).

- **Username**: Enter the username you use to access Snowflake.

- **Password**: Enter a Snowflake password. To improve data security, GX recommends using a Snowflake service account to connect to GX Cloud.

Expand All @@ -71,26 +71,24 @@ You can use an existing Snowflake warehouse, but GX recommends creating a separa

- **Role**: Enter your Snowflake role.

8. Optional. Select **Test connection** to test the Data Source connection. Testing the connection to the Data Source is a preventative measure that makes sure the connection configuration is correct. This verification can help you avoid errors and can reduce troubleshooting downtime.

9. Click **Continue**.
8. Click **Connect**.

10. Select **Table Asset** or **Query Asset** and complete the following fields:
9. Select **Table Asset** or **Query Asset** and complete the following fields:

- **Table name**: When **Table Asset** is selected, enter the name of the Data Source table you're connecting to.

- **Data Asset name**: Enter a name for the Data Asset. Data Asset names must be unique. If you use the same name for multiple Data Assets, each Data Asset must be associated with a unique Data Source.

- **Query**: When **Query Asset** is selected, enter the query that you want to run on the Data Asset.

11. Select the **Complete Asset** tab to provide all Data Asset records to your Expectations and validations, or select the **Batches** tab to use subsets of Data Asset records for your Expectations and validations. If you selected the **Batches** tab, complete the following fields:
10. Select the **Complete Asset** tab to provide all Data Asset records to your Expectations and validations, or select the **Batches** tab to use subsets of Data Asset records for your Expectations and validations. If you selected the **Batches** tab, complete the following fields:

- **Split Data Asset by** - Select **Year** to partition Data Asset records by year, select **Year - Month** to partition Data Asset records by year and month, or select **Year - Month - Day** to partition Data Asset records by year, month, and day.

- **Column of datetime type** - Enter the name of the column containing the date and time data.

12. Optional. Select **Add Data Asset** to add additional tables or queries and repeat steps 8 and 9.
11. Optional. Select **Add Data Asset** to add additional tables or queries and repeat steps 8 and 9.

13. Click **Finish**.
12. Click **Finish**.

14. Create an Expectation. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).
13. Create an Expectation. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).
34 changes: 15 additions & 19 deletions docs/docusaurus/docs/cloud/data_assets/manage_data_assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,29 +75,27 @@ Define the data you want GX Cloud to access within Snowflake.

- **Role**: Enter your Snowflake role.

7. Optional. Select **Test connection** to test the Data Source connection. Testing the connection to the Data Source is a preventative measure that makes sure the connection configuration is correct. This verification can help you avoid errors and can reduce troubleshooting downtime.
7. Click **Connect**.

8. Click **Continue**.

9. Select **Table Asset** or **Query Asset** and complete the following fields:
8. Select **Table Asset** or **Query Asset** and complete the following fields:

- **Table name**: When **Table Asset** is selected, enter a name for the table you're creating in the Data Asset.

- **Data Asset name**: Enter a name for the Data Asset. Data Asset names must be unique. If you use the same name for multiple Data Assets, each Data Asset must be associated with a unique Data Source.

- **Query**: When **Query Asset** is selected, enter the query that you want to run on the table.

10. Select the **Complete Asset** tab to provide all Data Asset records to your Expectations and validations, or select the **Batches** tab to use subsets of Data Asset records for your Expectations and validations. If you selected the **Batches** tab, complete the following fields:
9. Select the **Complete Asset** tab to provide all Data Asset records to your Expectations and validations, or select the **Batches** tab to use subsets of Data Asset records for your Expectations and validations. If you selected the **Batches** tab, complete the following fields:

- **Split Data Asset by** - Select **Year** to partition Data Asset records by year, select **Year - Month** to partition Data Asset records by year and month, or select **Year - Month - Day** to partition Data Asset records by year, month, and day.

- **Column of datetime type** - Enter the name of the column containing the date and time data.

11. Optional. Select **Add Data Asset** to add additional tables or queries and repeat steps 8 and 9.
10. Optional. Select **Add Data Asset** to add additional tables or queries and repeat steps 8 and 9.

12. Click **Finish**.
11. Click **Finish**.

13. Create an Expectation. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).
12. Create an Expectation. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).

</TabItem>
<TabItem value="PostgreSQL">
Expand Down Expand Up @@ -132,29 +130,27 @@ Define the data you want GX Cloud to access within PostgreSQL.

5. Enter a connection string in the **Connection string** field. The connection string format is `postgresql+psycopg2//YourUserName:YourPassword@YourHostname:5432/YourDatabaseName`.

6. Optional. Select **Test connection** to test the Data Source connection. Testing the connection to the Data Source is a preventative measure that makes sure the connection configuration is correct. This verification can help you avoid errors and can reduce troubleshooting downtime.
6. Click **Connect**.

7. Click **Continue**.

8. Select **Table Asset** or **Query Asset** and complete the following fields:
7. Select **Table Asset** or **Query Asset** and complete the following fields:

- **Table name**: When **Table Asset** is selected, enter a name for the table you're creating in the Data Asset.

- **Data Asset name**: Enter a name for the Data Asset. Data Asset names must be unique across all Data Sources in GX Cloud.

- **Query**: When **Query Asset** is selected, enter the query that you want to run on the table.

9. Select the **Complete Asset** tab to provide all Data Asset records to your Expectations and validations, or select the **Batches** tab to use subsets of Data Asset records for your Expectations and validations. If you selected the **Batches** tab, complete the following fields:
8. Select the **Complete Asset** tab to provide all Data Asset records to your Expectations and validations, or select the **Batches** tab to use subsets of Data Asset records for your Expectations and validations. If you selected the **Batches** tab, complete the following fields:

- **Split Data Asset by** - Select **Year** to partition Data Asset records by year, select **Year - Month** to partition Data Asset records by year and month, or select **Year - Month - Day** to partition Data Asset records by year, month, and day.

- **Column of datetime type** - Enter the name of the column containing the date and time data.

10. Optional. Select **Add Data Asset** to add additional tables or queries and repeat steps 8 and 9.
9. Optional. Select **Add Data Asset** to add additional tables or queries and repeat steps 8 and 9.

11. Click **Finish**.
10. Click **Finish**.

12. Create an Expectation. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).
11. Create an Expectation. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).

</TabItem>
</Tabs>
Expand Down Expand Up @@ -272,14 +268,14 @@ Edit Data Source settings to update Data Source connection information or access

4. Optional. Edit the Data Source name.

5. Optional. If you used a connection string to connect to the Data Source, click the **Use connection string** slider and edit the Data Source connection string.
5. Optional. If you used a connection string to connect to the Data Source, click the **Connection string** tab and edit the Data Source connection string.

6. Optional. If you're not using a connection string, edit the following fields:

- **Account identifier**: Enter new Snowflake account or locator information. The locator value must include the geographical region. For example, `us-east-1`. To locate these values see [Account Identifiers](https://docs.snowflake.com/en/user-guide/admin-account-identifier).

- **Username**: Enter a new Snowflake username.

- **Account identifier**: Enter new Snowflake account or locator information. The locator value must include the geographical region. For example, `us-east-1`. To locate these values see [Account Identifiers](https://docs.snowflake.com/en/user-guide/admin-account-identifier).

- **Password**: Enter the password for the Snowflake user you're connecting to GX Cloud. To improve data security, GX recommends using a Snowflake service account to connect to GX Cloud.

- **Database**: Enter a new Snowflake database name.
Expand Down

0 comments on commit ae54419

Please sign in to comment.