Package io.stargate.sdk.rest

Class ColumnsClient

java.lang.Object

io.stargate.sdk.rest.ColumnsClient

public class ColumnsClient
extends Object

Working with a Column.

Author:

Cedrick LUNVEN (@clunven)

Field Summary

Fields

Modifier and Type	Field	Description
Function<ServiceHttp,String>	columnSchemaResource	/v2/schemas/keyspaces/{keyspace}/tables/{tableName}/columns/{columnName}

Constructor Summary

Constructors

Constructor	Description
ColumnsClient(LoadBalancedHttpClient stargateHttpClient, TableClient tableClient, String columnId)	Constructor focusing on a single Column

Method Summary

Modifier and Type	Method	Description
void	create(ColumnDefinition cd)	Add a column.
void	delete()	Delete a column.
boolean	exist()	Check if the column exist on the
Optional<ColumnDefinition>	find()	Retrieve a column.
void	rename(String newName)	Update a column.

Methods inherited from class java.lang.Object

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

Field Details

columnSchemaResource

public Function<ServiceHttp,String> columnSchemaResource

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

Constructor Details

ColumnsClient

public ColumnsClient(LoadBalancedHttpClient stargateHttpClient,
 TableClient tableClient,
 String columnId)

Constructor focusing on a single Column

Parameters:

stargateHttpClient - stargateHttpClient

tableClient - table resource client

columnId - current column identifier

Method Details

find

public Optional<ColumnDefinition> find()

Retrieve a column.

Returns:

ColumnDefinition

See Also:

• Reference Documentation

exist

public boolean exist()

Check if the column exist on the

Returns:

boolean

create

public void create(ColumnDefinition cd)

Add a column.

Parameters:

cd - ColumnDefinition

See Also:

• Reference Documentation

delete

public void delete()

Delete a column.

See Also:

• Reference Documentation

rename

public void rename(String newName)

Update a column.

Parameters:

newName - String

See Also:

• Reference Documentation