Package io.stargate.sdk.rest

Class KeyspaceClient

java.lang.Object

io.stargate.sdk.rest.KeyspaceClient

public class KeyspaceClient
extends Object

Client for API resource /v2/namespaces.

Author:

Cedrick LUNVEN (@clunven)

Field Summary

Fields

Modifier and Type	Field	Description
Function<ServiceHttp,String>	keyspaceResource	/v2/keyspaces/{keyspace}
Function<ServiceHttp,String>	keyspaceSchemaResource	/v2/schemas/keyspaces/{keyspace}
static final String	PATH_KEYSPACES	URL parts.
static final String	PATH_TABLES	URL parts.
static final String	PATH_TYPES	URL parts.
Function<ServiceHttp,String>	tablesResource	/v2/keyspaces/{keyspace}/tables
Function<ServiceHttp,String>	tablesSchemaResource	/v2/schemas/keyspaces/{keyspace}/tables
Function<ServiceHttp,String>	typesResource	/v2/keyspaces/{keyspace}/types
Function<ServiceHttp,String>	typesSchemaResource	/v2/schemas/keyspaces/{keyspace}/types

Constructor Summary

Constructors

Constructor	Description
KeyspaceClient(StargateRestApiClient apiData, String keyspace)	Full constructor.

Method Summary

Modifier and Type	Method	Description
void	create(DataCenter... datacenters)	Create a keyspace providing the replications per Datacenter.
void	createSimple(int replicas)	Create a keyspace.
void	createTable(String tableName, CreateTable ct)	Syntax sugar more easier to understand in a fluent API.
void	delete()	Delete a keyspace.
boolean	exist()	Check it the keyspace exist.
Optional<Keyspace>	find()	Find a namespace and its metadata based on its id.
String	getKeyspace()	Getter accessor for attribute 'keyspace'.
TableClient	table(String tableName)	Move to the Table client
Stream<String>	tableNames()	Map to list only table names.
Stream<TableDefinition>	tables()	List tablenames in keyspace.
Map<String,TableDefinition>	tablesAsMap()	Sample collector as MAP of stream.
TypeClient	type(String typeName)	Move to the Type client
Stream<String>	typeNames()	Map to list only types names.
Stream<TypeDefinition>	types()	List types in the keyspace.

Methods inherited from class java.lang.Object

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

Field Details

PATH_KEYSPACES

public static final String PATH_KEYSPACES

URL parts.

See Also:

• Constant Field Values

PATH_TABLES

public static final String PATH_TABLES

URL parts.

See Also:

• Constant Field Values

PATH_TYPES

public static final String PATH_TYPES

URL parts.

See Also:

• Constant Field Values

keyspaceResource

public Function<ServiceHttp,String> keyspaceResource

/v2/keyspaces/{keyspace}

keyspaceSchemaResource

public Function<ServiceHttp,String> keyspaceSchemaResource

/v2/schemas/keyspaces/{keyspace}

tablesResource

public Function<ServiceHttp,String> tablesResource

/v2/keyspaces/{keyspace}/tables

tablesSchemaResource

public Function<ServiceHttp,String> tablesSchemaResource

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

typesResource

public Function<ServiceHttp,String> typesResource

/v2/keyspaces/{keyspace}/types

typesSchemaResource

public Function<ServiceHttp,String> typesSchemaResource

/v2/schemas/keyspaces/{keyspace}/types

Constructor Details

KeyspaceClient

public KeyspaceClient(StargateRestApiClient apiData,
 String keyspace)

Full constructor.

Parameters:

apiData - apiData

keyspace - String

Method Details

find

public Optional<Keyspace> find()

Find a namespace and its metadata based on its id.

Returns:

Keyspace

See Also:

• Reference Documentation

exist

public boolean exist()

Check it the keyspace exist.

Returns:

boolean

create

public void create(DataCenter... datacenters)

Create a keyspace providing the replications per Datacenter.

Parameters:

datacenters - DataCenter

See Also:

• Reference Documentation

createSimple

public void createSimple(int replicas)

Create a keyspace.

Parameters:

replicas - int

See Also:

• Reference Documentation

delete

public void delete()

Delete a keyspace.

See Also:

• Reference Documentation

tables

public Stream<TableDefinition> tables()

List tablenames in keyspace.

Returns:

TableDefinition

See Also:

• Reference Documentation

tablesAsMap

public Map<String,TableDefinition> tablesAsMap()

Sample collector as MAP of stream.

Returns:

map

types

public Stream<TypeDefinition> types()

List types in the keyspace.

Returns:

list of types.

See Also:

• Reference Documentation

tableNames

public Stream<String> tableNames()

Map to list only table names.

Returns:

Stream

typeNames

public Stream<String> typeNames()

Map to list only types names.

Returns:

Stream

table

public TableClient table(String tableName)

Move to the Table client

Parameters:

tableName - String

Returns:

TableClient

type

public TypeClient type(String typeName)

Move to the Type client

Parameters:

typeName - String

Returns:

TypeClient

createTable

public void createTable(String tableName,
 CreateTable ct)

Syntax sugar more easier to understand in a fluent API.

Parameters:

tableName - tableName

ct - CreateTable

See Also:

• Reference Documentation

getKeyspace

public String getKeyspace()

Getter accessor for attribute 'keyspace'.

Returns:

current value of 'keyspace'