io.debezium.relational

Class TableId

java.lang.Object

io.debezium.relational.TableId

All Implemented Interfaces:

Comparable<TableId>

@Immutable
public final class TableId
extends Object
implements Comparable<TableId>

Unique identifier for a database table.

Author:

Randall Hauch

Field Summary

Fields

Modifier and Type	Field and Description
private String	catalogName
private String	id
private String	schemaName
private String	tableName

Constructor Summary

Constructors

Constructor and Description
TableId(String catalogName, String schemaName, String tableName) Create a new table identifier.

Method Summary

Modifier and Type	Method and Description
String	catalog() Get the name of the JDBC catalog.
int	compareTo(TableId that)
int	compareToIgnoreCase(TableId that)
boolean	equals(Object obj)
static Predicate<TableId>	filter(String dbWhitelist, String dbBlacklist, String tableWhitelist, String tableBlacklist) Create a predicate function that allows only those TableIds that are allowed by the database whitelist (or not disallowed by the database blacklist) and allowed by the table whitelist (or not disallowed by the table blacklist).
int	hashCode()
static TableId	parse(String str) Parse the supplied string delimited with a period (.) character, extracting up to the first 3 parts into a TableID.
static TableId	parse(String str, char delimiter, boolean useCatalogBeforeSchema) Parse the supplied string, extracting up to the first 3 parts into a TableID.
String	schema() Get the name of the JDBC schema.
String	table() Get the name of the table.
private static String	tableId(String catalog, String schema, String table)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

catalogName

private final String catalogName

schemaName

private final String schemaName

tableName

private final String tableName

id

private final String id

Constructor Detail

TableId

public TableId(String catalogName,
               String schemaName,
               String tableName)

Create a new table identifier.

Parameters:

catalogName - the name of the database catalog that contains the table; may be null if the JDBC driver does not show a schema for this table

schemaName - the name of the database schema that contains the table; may be null if the JDBC driver does not show a schema for this table

tableName - the name of the table; may not be null

Method Detail

filter

public static Predicate<TableId> filter(String dbWhitelist,
                                        String dbBlacklist,
                                        String tableWhitelist,
                                        String tableBlacklist)

Create a predicate function that allows only those TableIds that are allowed by the database whitelist (or not disallowed by the database blacklist) and allowed by the table whitelist (or not disallowed by the table blacklist). Therefore, blacklists are only used if there is no corresponding whitelist.

Qualified table names are comma-separated strings that are each parsed into TableId objects.

Parameters:

dbWhitelist - the comma-separated string listing the names of the databases to be explicitly allowed; may be null

dbBlacklist - the comma-separated string listing the names of the databases to be explicitly disallowed; may be null

tableWhitelist - the comma-separated string listing the qualified names of the tables to be explicitly allowed; may be null

tableBlacklist - the comma-separated string listing the qualified names of the tables to be explicitly disallowed; may be null

Returns:

the predicate function; never null

parse

public static TableId parse(String str)

Parse the supplied string delimited with a period (.) character, extracting up to the first 3 parts into a TableID. If the input contains only two parts, then the first part will be used as the catalog name and the second as the table name.

Parameters:

str - the input string

Returns:

the table ID, or null if it could not be parsed

parse

public static TableId parse(String str,
                            char delimiter,
                            boolean useCatalogBeforeSchema)

Parse the supplied string, extracting up to the first 3 parts into a TableID.

Parameters:

str - the input string

delimiter - the delimiter between parts

useCatalogBeforeSchema - true if the parsed string contains only 2 items and the first should be used as the catalog and the second as the table name, or false if the first should be used as the schema and the second as the table name

Returns:

the table ID, or null if it could not be parsed

catalog

public String catalog()

Get the name of the JDBC catalog.

Returns:

the catalog name, or null if the table does not belong to a catalog

schema

public String schema()

Get the name of the JDBC schema.

Returns:

the JDBC schema name, or null if the table does not belong to a JDBC schema

table

public String table()

Get the name of the table.

Returns:

the table name; never null

compareTo

public int compareTo(TableId that)

Specified by:

compareTo in interface Comparable<TableId>

compareToIgnoreCase

public int compareToIgnoreCase(TableId that)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

tableId

private static String tableId(String catalog,
                              String schema,
                              String table)