Package io.stargate.sdk.rest

Class TableClient

java.lang.Object

io.stargate.sdk.rest.TableClient

public class TableClient
extends Object

Operate on Tables in Cassandra.

Author:

Cedrick LUNVEN (@clunven)

Field Summary

Fields

Modifier and Type	Field	Description
Function<ServiceHttp,String>	columnsSchemaResource	/v2/schemas/keyspaces/{keyspace}/tables/{tableName}/columns
Function<ServiceHttp,String>	indexesSchemaResource	/v2/schemas/keyspaces/{keyspace}/tables/{tableName}/indexes
static final String	PATH_COLUMNS	URL Parts.
static final String	PATH_INDEXES	URL Parts.
Function<ServiceHttp,String>	tableResource	/v2/keyspaces/{keyspace}/tables/{tableName}
Function<ServiceHttp,String>	tableSchemaResource	/v2/schemas/keyspaces/{keyspace}/tables/{tableName}

Constructor Summary

Constructors

Constructor	Description
TableClient(LoadBalancedHttpClient stargateHttpClient, KeyspaceClient keyspaceClient, String tableName)	Full constructor.

Method Summary

Modifier and Type	Method	Description
ColumnsClient	column(String columnId)	Move to columns client
Stream<String>	columnNames()	Retrieve All column names.
Stream<ColumnDefinition>	columns()	Retrieve All columns.
void	create(CreateTable tcr)	Create a table.
void	createColumn(String colName, ColumnDefinition cd)	Create a Column.
void	createIndex(String idxName, CreateIndex ci)	Create an index.
void	delete()	Delete a table.
boolean	exist()	Check if the table exist.
Optional<TableDefinition>	find()	Get a table.
String	getTableName()	Getter accessor for attribute 'tableName'.
IndexClient	index(String indexName)	Move to columns client
Stream<IndexDefinition>	indexes()	Retrieve All indexes for a table.
Stream<String>	indexesNames()	Retrieve All indexes names.
KeyClient	key(Object... keys)	Move to the Table client
RowResultPage	search(SearchTableQuery query)	Search a table.
<T> Page<T>	search(SearchTableQuery query, RowMapper<T> mapper)	Retrieve a set of Rows from Primary key value.
void	updateOptions(TableOptions to)	Replace a table definition (table options only).
void	upsert(Map<String,Object> record)	Add Rows.

Methods inherited from class java.lang.Object

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

Field Details

PATH_COLUMNS

public static final String PATH_COLUMNS

URL Parts.

See Also:

• Constant Field Values

PATH_INDEXES

public static final String PATH_INDEXES

URL Parts.

See Also:

• Constant Field Values

tableSchemaResource

public Function<ServiceHttp,String> tableSchemaResource

/v2/schemas/keyspaces/{keyspace}/tables/{tableName}

tableResource

public Function<ServiceHttp,String> tableResource

/v2/keyspaces/{keyspace}/tables/{tableName}

columnsSchemaResource

public Function<ServiceHttp,String> columnsSchemaResource

/v2/schemas/keyspaces/{keyspace}/tables/{tableName}/columns

indexesSchemaResource

public Function<ServiceHttp,String> indexesSchemaResource

/v2/schemas/keyspaces/{keyspace}/tables/{tableName}/indexes

Constructor Details

TableClient

public TableClient(LoadBalancedHttpClient stargateHttpClient,
 KeyspaceClient keyspaceClient,
 String tableName)

Full constructor.

Parameters:

stargateHttpClient - apiDataClient

keyspaceClient - KeyspaceClient

tableName - name of the table

Method Details

find

public Optional<TableDefinition> find()

Get a table.

Returns:

metadata of the collection if its exist or empty

See Also:

• Reference Documentation

exist

public boolean exist()

Check if the table exist.

Returns:

boolean

create

public void create(CreateTable tcr)

Create a table.

Parameters:

tcr - creation request

See Also:

• Reference Documentation

updateOptions

public void updateOptions(TableOptions to)

Replace a table definition (table options only).

Parameters:

to - TableOptions

See Also:

• Reference Documentation

delete

public void delete()

Delete a table.

See Also:

• Reference Documentation

upsert

public void upsert(Map<String,Object> record)

Add Rows.

Parameters:

record - map of recors

See Also:

• Reference Documentation

search

public RowResultPage search(SearchTableQuery query)

Search a table.

Parameters:

query - search params with filters and ordering

Returns:

RowResultPage

See Also:

• Reference Documentation

search

public <T> Page<T> search(SearchTableQuery query,
 RowMapper<T> mapper)

Retrieve a set of Rows from Primary key value.

Type Parameters:

T - marshalling bean

Parameters:

query - SearchTableQuery

mapper - mapping result to bean with a mapper

Returns:

ResultPage pageable result

See Also:

• Reference Documentation

columns

public Stream<ColumnDefinition> columns()

Retrieve All columns.

Returns:

Sream of ColumnDefinition to describe a table

See Also:

• Reference Documentation

createColumn

public void createColumn(String colName,
 ColumnDefinition cd)

Create a Column.

Parameters:

colName - String

cd - ColumnDefinition

See Also:

• Reference Documentation

columnNames

public Stream<String> columnNames()

Retrieve All column names.

Returns:

a list of columns names;

indexes

public Stream<IndexDefinition> indexes()

Retrieve All indexes for a table.

Returns:

Stream of IndexDefinition to describe a table

See Also:

• Reference Documentation

createIndex

public void createIndex(String idxName,
 CreateIndex ci)

Create an index.

Parameters:

idxName - String

ci - CreateIndex

See Also:

• Reference Documentation

indexesNames

public Stream<String> indexesNames()

Retrieve All indexes names.

Returns:

a list of columns names;

column

public ColumnsClient column(String columnId)

Move to columns client

Parameters:

columnId - String

Returns:

ColumnsClient

index

public IndexClient index(String indexName)

Move to columns client

Parameters:

indexName - String

Returns:

IndexClient

key

public KeyClient key(Object... keys)

Move to the Table client

Parameters:

keys - Object

Returns:

KeyClient

getTableName

public String getTableName()

Getter accessor for attribute 'tableName'.

Returns:

current value of 'tableName'