feat(ibis): Implement Snowflake Metadata APIs

[ongdisheng]

Implement Snowflake Metadata APIs #709

(POST) /v2/connector/snowflake/metadata/tables

Request payload example

{
  "connectionInfo": {
    "user": "my-user",
    "password": "my-pwd",
    "account": "my-account",
    "database": "my-db",
    "schema": "my-schema"
  }
}

Response example

• name: unique table name
• columns
  • name: column name in the datasource
  • type: column data type
  • notNull: boolean, nullable or not
  • description: column description(comment) if any
  • properties: column properties if any
• description: table description if any
• properties
  • schema: schema name to build tableReference
  • catalog: catalog name to build tableReference
  • table: table name to build tableReference
• primaryKey: the column name which is bind with primary constraint

[
    {
        "name": "db.REGION",
        "columns": [
            {
                "name": "R_COMMENT",
                "type": "VARCHAR",
                "notNull": false,
                "description": "",
                "properties": null
            }
        ],
        "description": "",
        "properties": {
            "schema": "db",
            "catalog": "def",
            "table": "REGION"
        },
        "primaryKey": ""
    },
]

(POST) /v2/connector/snowflake/metadata/constraints

Request payload example

{
  "connectionInfo": {
    "user": "my-user",
    "password": "my-pwd",
    "account": "my-account",
    "database": "my-db",
    "schema": "my-schema"
  }
}

Response example

• constraints
  • constraintName: unique constraint name
    ({constraint_table}_{constraint_column}_{constrainted_table}_{constrainted_column})
  • constraintType: “FOREIGN KEY”
  • constraintTable
  • constraintColumn
  • constraintedTable
  • constraintedColumn

[
    {
        "constraintName": "ORDERS_O_CUSTKEY_CUSTOMER_C_CUSTKEY",
        "constraintType": "FOREIGN KEY",
        "constraintTable": "db.ORDERS",
        "constraintColumn": "O_CUSTKEY",
        "constraintedTable": "db.CUSTOMER",
        "constraintedColumn": "C_CUSTKEY"
    },
]

[ongdisheng]

Hi @grieve54706 @goldmedal, could you take a look at my PR when you have some free time? I'd really appreciate your feedback, thanks in advance!

[goldmedal]

Thanks @ongdisheng. Overall looks good to me 👍 . Let's wait for @grieve54706 to review it.

[grieve54706]

Well done. Thanks for your contribution. Welcome @ongdisheng.

[ongdisheng]

@goldmedal @grieve54706, thanks for the quick feedback! I’ll have the fixes ready later today.

[grieve54706]

Hi @ongdisheng,
Could you add expected like test_metadata_list_tables too?
You did a good job. Thanks for your help.

[ongdisheng]

Hi @grieve54706, I've noticed that the TPCH_SF1 schema doesn’t seem to enforce foreign key constraints, which causes the SHOW IMPORTED KEYS command to return an empty list.

Here are the results I found when querying the TABLE_CONSTRAINTS:

Given this, would it be appropriate to add an assertion to check that the result returns an empty list? I’d be glad to hear any other suggestions you may have. Thank you!

[grieve54706]

Yes, asserting it is an empty list is a good choice.

[grieve54706]

LGTM. Thanks @ongdisheng.

[goldmedal]

Thanks @ongdisheng and @grieve54706 for reviewing 👍