Package io.stargate.sdk.rest

Class KeyClient

java.lang.Object

io.stargate.sdk.rest.KeyClient

public class KeyClient
extends Object

Operation on a record.

Author:

Cedrick LUNVEN (@clunven)

Field Summary

Fields

Modifier and Type	Field	Description
Function<ServiceHttp,String>	primaryKeyResource	/v2/schemas/keyspaces/{keyspace}/tables/{tableName}/{key1}/...{keyn}

Constructor Summary

Constructors

Constructor	Description
KeyClient(LoadBalancedHttpClient stargateHttpClient, TableClient tableClient, Object... keys)	Full constructor.

Method Summary

Modifier and Type	Method	Description
void	delete()	Delete by key
Stream<ObjectMap>	findAll()	Retrieve a set of Rows from Primary key value.
<T> Stream<T>	findAll(RowMapper<T> rowMapper)	Marshall output as objects.
RowResultPage	findFirstPage(int pageSize)	Find the first page (when we know there are not a lot)
RowResultPage	findPage(int pageSize, String pageState)	Search for a page.
RowResultPage	findPage(QueryWithKey query)	Retrieve a set of Rows from Primary key value.
<T> Page<T>	findPage(QueryWithKey query, RowMapper<T> mapper)	Retrieve a set of Rows from Primary key value.
void	replace(Map<String,Object> newRecord)	replace
void	update(Map<String,Object> newRecord)	update

Methods inherited from class java.lang.Object

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

Field Details

primaryKeyResource

public Function<ServiceHttp,String> primaryKeyResource

/v2/schemas/keyspaces/{keyspace}/tables/{tableName}/{key1}/...{keyn}

Constructor Details

KeyClient

public KeyClient(LoadBalancedHttpClient stargateHttpClient,
 TableClient tableClient,
 Object... keys)

Full constructor.

Parameters:

stargateHttpClient - stargateHttpClient

tableClient - TableClient

keys - Object

Method Details

findAll

public Stream<ObjectMap> findAll()

Retrieve a set of Rows from Primary key value.

Returns:

a list of rows

findAll

public <T> Stream<T> findAll(RowMapper<T> rowMapper)

Marshall output as objects.

Type Parameters:

T - current row

Parameters:

rowMapper - row mapper

Returns:

target return

findFirstPage

public RowResultPage findFirstPage(int pageSize)

Find the first page (when we know there are not a lot)

Parameters:

pageSize - list of page

Returns:

returned a list

findPage

public RowResultPage findPage(int pageSize,
 String pageState)

Search for a page.

Parameters:

pageSize - size of expected page

pageState - cursor in research

Returns:

a page of results

findPage

public RowResultPage findPage(QueryWithKey query)

Retrieve a set of Rows from Primary key value.

Parameters:

query - QueryWithKey

Returns:

RowResultPage

See Also:

• Reference Documentation

findPage

public <T> Page<T> findPage(QueryWithKey query,
 RowMapper<T> mapper)

Retrieve a set of Rows from Primary key value.

Type Parameters:

T - T

Parameters:

query - QueryWithKey

mapper - RowMapper

Returns:

ResultPage

See Also:

• Reference Documentation

delete

public void delete()

Delete by key

See Also:

• Reference Documentation

update

public void update(Map<String,Object> newRecord)

update

Parameters:

newRecord - Map

See Also:

• Reference Documentation

replace

public void replace(Map<String,Object> newRecord)

replace

Parameters:

newRecord - Map

See Also:

• Reference Documentation