Key (Debezium Core 1.8.1.Final API)

java.lang.Object
- io.debezium.relational.Key

```
@Immutable
public class Key
extends Object
```
An immutable definition of a table's key. By default, the key will be comprised of the primary key column(s). A key can be customized with a KeyMapper.

Author:

Guillaume Rosauro

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`Key.Builder`
`static class`	`Key.CustomKeyMapper`	Custom Key mapper used to override or defining a custom `Key`
`private static class`	`Key.IdentityKeyMapper`	Default Key mapper using PK as key.
`static interface`	`Key.KeyMapper`	Provides the column(s) that should be used within the message key for a given table.

Field Summary

Fields
Modifier and Type Field Description

private Key.KeyMapper keyMapper

private Table table

Constructor Summary

Constructors
Modifier Constructor Description

private Key(Table table, Key.KeyMapper keyMapper)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

List<Column> keyColumns()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

table
```
private final Table table
```

keyMapper
```
private final Key.KeyMapper keyMapper
```

Constructor Detail

Key

private Key(Table table,
            Key.KeyMapper keyMapper)

Method Detail
- keyColumns
```
public List<Column> keyColumns()
```
  Returns:
  
  the columns Column taking part of the key.