com.databricks.sdk.service.catalog

Class TableConstraintsAPI

java.lang.Object

com.databricks.sdk.service.catalog.TableConstraintsAPI

@Generated
public class TableConstraintsAPI
extends Object

Primary key and foreign key constraints encode relationships between fields in tables.

Primary and foreign keys are informational only and are not enforced. Foreign keys must reference a primary key in another table. This primary key is the parent constraint of the foreign key and the table this primary key is on is the parent table of the foreign key. Similarly, the foreign key is the child constraint of its referenced primary key; the table of the foreign key is the child table of the primary key.

You can declare primary keys and foreign keys as part of the table specification during table creation. You can also add or drop constraints on existing tables.

Constructor Summary

Constructors

Constructor and Description
TableConstraintsAPI(ApiClient apiClient) Regular-use constructor
TableConstraintsAPI(TableConstraintsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
TableConstraint	create(CreateTableConstraint request) Create a table constraint.
TableConstraint	create(String fullNameArg, TableConstraint constraint)
void	delete(DeleteTableConstraintRequest request) Delete a table constraint.
void	delete(String fullName, String constraintName, boolean cascade)
TableConstraintsService	impl()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TableConstraintsAPI

public TableConstraintsAPI(ApiClient apiClient)

Regular-use constructor

TableConstraintsAPI

public TableConstraintsAPI(TableConstraintsService mock)

Constructor for mocks

Method Detail

create

public TableConstraint create(String fullNameArg,
                              TableConstraint constraint)

create

public TableConstraint create(CreateTableConstraint request)

Create a table constraint.

Creates a new table constraint.

For the table constraint creation to succeed, the user must satisfy both of these conditions: - the user must have the **USE_CATALOG** privilege on the table's parent catalog, the **USE_SCHEMA** privilege on the table's parent schema, and be the owner of the table. - if the new constraint is a __ForeignKeyConstraint__, the user must have the **USE_CATALOG** privilege on the referenced parent table's catalog, the **USE_SCHEMA** privilege on the referenced parent table's schema, and be the owner of the referenced parent table.

delete

public void delete(String fullName,
                   String constraintName,
                   boolean cascade)

delete

public void delete(DeleteTableConstraintRequest request)

Delete a table constraint.

Deletes a table constraint.

For the table constraint deletion to succeed, the user must satisfy both of these conditions: - the user must have the **USE_CATALOG** privilege on the table's parent catalog, the **USE_SCHEMA** privilege on the table's parent schema, and be the owner of the table. - if __cascade__ argument is **true**, the user must have the following permissions on all of the child tables: the **USE_CATALOG** privilege on the table's catalog, the **USE_SCHEMA** privilege on the table's schema, and be the owner of the table.

impl

public TableConstraintsService impl()