Package com.clickhouse.client.api.metadata

Class TableSchema

java.lang.Object

com.clickhouse.client.api.metadata.TableSchema

public class TableSchema
extends Object

Constructor Summary

Constructors

Constructor	Description
TableSchema(String tableName, String query, String databaseName, Collection<ClickHouseColumn> columns)
TableSchema(Collection<ClickHouseColumn> columns)

Method Summary

Modifier and Type	Method	Description
String	columnIndexToName(int index)	Takes absolute index (starting from 1) and return corresponding column.
ClickHouseColumn	getColumnByIndex(int colIndex)	Returns column by index.
ClickHouseColumn	getColumnByName(String name)
List<ClickHouseColumn>	getColumns()	Returns unmodifiable collection of columns.
String	getDatabaseName()
String	getQuery()
String	getTableName()
boolean	hasDefaults()
String	indexToName(int index)	Takes absolute index (starting from 0) and returns corresponding column.
int	nameToColumnIndex(String name)	Takes column name and return corresponding index (starting from 1).
int	nameToIndex(String name)	Takes column name and return corresponding index (starting from 0).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

TableSchema

public TableSchema(Collection<ClickHouseColumn> columns)

TableSchema

public TableSchema(String tableName,
 String query,
 String databaseName,
 Collection<ClickHouseColumn> columns)

Method Details

getColumns

public List<ClickHouseColumn> getColumns()

Returns unmodifiable collection of columns.

Returns:

- collection of columns in the table

getDatabaseName

public String getDatabaseName()

getTableName

public String getTableName()

hasDefaults

public boolean hasDefaults()

getQuery

public String getQuery()

getColumnByName

public ClickHouseColumn getColumnByName(String name)

getColumnByIndex

public ClickHouseColumn getColumnByIndex(int colIndex)

Returns column by index. Index starts with 1.

Parameters:

colIndex - - column index;

Returns:

indexToName

public String indexToName(int index)

Takes absolute index (starting from 0) and returns corresponding column.

Parameters:

index - - column index starting from 0

Returns:

- column name

columnIndexToName

public String columnIndexToName(int index)

Takes absolute index (starting from 1) and return corresponding column. Equals to indexToName(index - 1.

Parameters:

index - - column index starting from 1

Returns:

- column name.

nameToColumnIndex

public int nameToColumnIndex(String name)

Takes column name and return corresponding index (starting from 1). Equals to nameToIndex(name) + 1.

Parameters:

name - - column name

Returns:

- column index starting from 1

nameToIndex

public int nameToIndex(String name)

Takes column name and return corresponding index (starting from 0).

Parameters:

name - - column name

Returns:

- column index starting from 0

toString

public String toString()

Overrides:

toString in class Object