PostgreSQL catalog

Overview

Apache Gravitino provides the ability to manage PostgreSQL metadata.

warning

Gravitino saves some system information in schema and table comment, like (From Gravitino, DO NOT EDIT: gravitino.v1.uid1078334182909406185), do not change or remove this message.

Catalog

Capabilities

• Gravitino catalog corresponds to the PostgreSQL database.
• Supports metadata management of PostgreSQL (12.x, 13.x, 14.x, 15.x, 16.x).
• Supports DDL operation for PostgreSQL schemas and tables.
• Supports table index.
• Supports column default value. and auto-increment.

Properties

Any property that isn't defined by Gravitino can pass to PostgreSQL data source by adding gravitino.bypass. prefix as a catalog property. For example, catalog property gravitino.bypass.maxWaitMillis will pass maxWaitMillis to the data source property. Check the relevant data source configuration in data source properties

When using Gravitino with Trino, pass the Trino PostgreSQL connector configuration using the trino.bypass. prefix. For example, using trino.bypass.join-pushdown.strategy to pass the join-pushdown.strategy to the Gravitino PostgreSQL catalog in Trino runtime.

If you use JDBC catalog, you must provide jdbc-url, jdbc-driver, jdbc-database, jdbc-user and jdbc-password to catalog properties. Besides the common catalog properties, the PostgreSQL catalog has the following properties:

Configuration item	Description	Default value	Required
jdbc-url	JDBC URL for connecting to the database. You need to specify the database in the URL. For example jdbc:postgresql://localhost:3306/pg_database?sslmode=require.	(none)	Yes
jdbc-driver	The driver of the JDBC connection. For example org.postgresql.Driver.	(none)	Yes
jdbc-database	The database of the JDBC connection. Configure it with the same value as the database in the jdbc-url. For example pg_database.	(none)	Yes
jdbc-user	The JDBC user name.	(none)	Yes
jdbc-password	The JDBC password.	(none)	Yes
jdbc.pool.min-size	The minimum number of connections in the pool. 2 by default.	2	No
jdbc.pool.max-size	The maximum number of connections in the pool. 10 by default.	10	No
jdbc.pool.max-wait-ms	The maximum Duration that the pool will wait for a connection to be returned. 30000 by default.	30000	No

Download the corresponding JDBC driver to the catalogs/jdbc-postgresql/libs directory. Explicitly specify the database in both jdbc-url and jdbc-database. An error may occur if the values in both aren't consistent. In PostgreSQL, the database corresponds to the Gravitino catalog, and the schema corresponds to the Gravitino schema.

Operations

Refer to Manage Relational Metadata Using Gravitino for more details.

Sensitive catalog properties such as jdbc-user and jdbc-password are hidden from the load catalog response. Use the credential vending API to retrieve them at runtime.

Schema

Capabilities

• Gravitino schema corresponds to the PostgreSQL schema.
• Supports creating schema with comments.
• Supports dropping schema.
• Supports cascade dropping schema.

Properties

• Doesn't support any schema property settings.

Operations

Refer to Manage Relational Metadata Using Gravitino for more details.

Table

Capabilities

• The Gravitino table corresponds to the PostgreSQL table.
• Supports DDL operation for PostgreSQL tables.
• Supports index.
• Support column default value and auto-increment.
• Doesn't support table property settings.

Column types

Gravitino Type	PostgreSQL Type
Boolean	Bool
Short	Int2
Integer	Int4
Long	Int8
Float	Float4
Double	Float8
String	Text
Date	Date
Time(p)	Time(p)
Timestamp(p)	Timestamp(p)
Timestamp_tz(p)	Timestamptz(p)
Decimal	Numeric
VarChar	Varchar
FixedChar	Bpchar
Binary	Bytea
UUID	Uuid
List	Array

PostgreSQL doesn't support Gravitino Fixed Struct Map IntervalDay IntervalYear Union type. Meanwhile, the data types other than listed above are mapped to Gravitino External Type that represents an unresolvable data type.

Column auto-increment

• Supports setting auto-increment.

Properties

• Doesn't support table properties.

Indexes

• Supports PRIMARY_KEY and UNIQUE_KEY.

JSON

Define primary and unique keys

{
  "indexes": [
    {
      "indexType": "primary_key",
      "name": "id_pk",
      "fieldNames": [["id"]]
    },
    {
      "indexType": "unique_key",
      "name": "id_name_uk",
      "fieldNames": [["id"] ,["name"]]
    }
  ]
}

Java

Define primary and unique keys

Index[] indexes = new Index[] {
    Indexes.of(IndexType.PRIMARY_KEY, "PRIMARY", new String[][]{{"id"}}, Map.of()),
    Indexes.of(IndexType.UNIQUE_KEY, "id_name_uk", new String[][]{{"id"} , {"name"}}, Map.of()),
}

Operations

Refer to Manage Relational Metadata Using Gravitino for more details.

Alter operations

Supports operations:

• RenameTable
• UpdateComment
• AddColumn
• DeleteColumn
• RenameColumn
• UpdateColumnType
• UpdateColumnNullability
• UpdateColumnComment
• UpdateColumnDefaultValue

You can't submit the RenameTable operation at the same time as other operations.

PostgreSQL doesn't support the UpdateColumnPosition operation, so you can only use ColumnPosition.defaultPosition() when AddColumn. If you update a nullability column to non nullability, there may be compatibility issues.