Package io.debezium.metadata

Class CollectionId

java.lang.Object

io.debezium.metadata.CollectionId

public class CollectionId
extends Object

An abstract data model that represents a table or collection of a datastore in its hierarchy. (e.g. server/catalog/database, schema, table).
It can either have two levels (namespace and name) or three levels (realm, namespace and name), depending on the requirements of underlying datastore:
realm: The optional highest layer, used for datastores that have a concept of three layers. For example MySQL and Oracle have database, schema and table, where database would be the highest layer and will be represented by realm.
namespace: The second-highest layer, used for datastores that have a concept of three or two layers. For example MySQL and Oracle have database, schema and table, where schema would be the second layer and will be represented by namespace. PostgreSQL only has schema and table, then schema will be represented by namespace.
name: The lowest layer, used for datastores that have a concept of three, two or one single layer hierarchy. This is usually the table layer of a relational database or the collection in MongoDB or similar datastores (e.g. document stores, key-value stores), this layer will then be represented by name.
Also acts as model class representing the structure of the response for the REST Extension call that returns the matching tables/collections on the `validate filters` endpoint.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	name	table or collection
private final String	namespace	catalog, schema or replica set name
private final String	realm	optional database or schema name

Constructor Summary

Constructors

Constructor	Description
CollectionId(String name)
CollectionId(String namespace, String name)
CollectionId(String realm, String namespace, String name)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
String	identifier()
String	name()
String	namespace()
String	realm()
String	toFullIdentiferString()
CollectionId	toLowerCase()
String	toString()
CollectionId	toUpperCase()

Methods inherited from class java.lang.Object

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

Field Details

namespace

private final String namespace

catalog, schema or replica set name

name

private final String name

table or collection

realm

private final String realm

optional database or schema name

Constructor Details

CollectionId

public CollectionId(String realm,
 String namespace,
 String name)

CollectionId

public CollectionId(String namespace,
 String name)

CollectionId

public CollectionId(String name)

Method Details

identifier

public String identifier()

realm

public String realm()

namespace

public String namespace()

name

public String name()

toString

public String toString()

Overrides:

toString in class Object

toFullIdentiferString

public String toFullIdentiferString()

toUpperCase

public CollectionId toUpperCase()

toLowerCase

public CollectionId toLowerCase()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object