Package io.hstream

Interface HStreamClient

All Superinterfaces:

AutoCloseable

public interface HStreamClient
extends AutoCloseable

A client for the HStreamDB.

Method Summary

Modifier and Type	Method	Description
void	alterConnectorConfig(String name, String config)
static HStreamClientBuilder	builder()
Connector	createConnector(CreateConnectorRequest request)
Query	createQuery(String name, String sql)
void	createStream(Stream stream)	Create a new stream.
void	createStream(String stream)	Create a new stream with 1 replicas.
void	createStream(String stream, short replicationFactor)	Create a new stream.
void	createStream(String stream, short replicationFactor, int shardCount)	Create a new stream.
void	createStream(String stream, short replicationFactor, int shardCount, int backlogDuration)	Create a new stream.
void	createSubscription(Subscription subscription)	Create a new Subscription.
void	deleteConnector(String name)
void	deleteQuery(String name)
void	deleteStream(String stream)	Delete the specified stream with streamName.
void	deleteStream(String stream, boolean force)	Delete the specified stream with streamName.
void	deleteSubscription(String subscriptionId)	Delete the specified subscription with subscriptionId.
void	deleteSubscription(String subscriptionId, boolean force)	Delete the specified subscription with subscriptionId.
void	deleteView(String name)
Cluster	describeCluster()
List<HRecord>	executeViewQuery(String sql)	only support to execute view query, e.g.
Connector	getConnector(String name)
String	getConnectorLogs(String name, int begin, int count)
String	getConnectorSpec(String type, String target)
Query	getQuery(String name)
GetStreamResponse	getStream(String streamName)
GetSubscriptionResponse	getSubscription(String subscriptionId)
String	getTailRecordId(String streamName, long shardId)
View	getView(String name)
List<Connector>	listConnectors()
List<ConsumerInformation>	listConsumers(String subscriptionId)
List<Query>	listQueries()
List<Shard>	listShards(String streamName)	List shards in a stream.
List<Stream>	listStreams()	List all streams.
List<Subscription>	listSubscriptions()	List all subscriptions.
List<View>	listViews()
BufferedProducerBuilder	newBufferedProducer()
ConsumerBuilder	newConsumer()
ProducerBuilder	newProducer()
QueryerBuilder	newQueryer()	Deprecated.
ReaderBuilder	newReader()	Deprecated.
StreamKeyReaderBuilder	newStreamKeyReader()
StreamShardReaderBuilder	newStreamShardReader()
void	terminateQuery(String name)
void	trimShards(String stream, List<String> records)

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

builder

static HStreamClientBuilder builder()

Returns:

a HStreamClientBuilder

newProducer

ProducerBuilder newProducer()

Returns:

a ProducerBuilder

newBufferedProducer

BufferedProducerBuilder newBufferedProducer()

newConsumer

ConsumerBuilder newConsumer()

Returns:

a ConsumerBuilder

newQueryer

@Deprecated
QueryerBuilder newQueryer()

Deprecated.

newReader

@Deprecated
ReaderBuilder newReader()

Deprecated.

newStreamShardReader

StreamShardReaderBuilder newStreamShardReader()

newStreamKeyReader

StreamKeyReaderBuilder newStreamKeyReader()

createStream

void createStream(String stream)

Create a new stream with 1 replicas.

Parameters:

stream - the name of stream

createStream

void createStream(String stream,
                  short replicationFactor)

Create a new stream.

Parameters:

stream - the name of the stream

replicationFactor - replication factor of the stream

createStream

void createStream(String stream,
                  short replicationFactor,
                  int shardCount)

Create a new stream.

Parameters:

stream - the name of the stream

replicationFactor - replication factor of the stream

shardCount - number of shards in the stream

createStream

void createStream(String stream,
                  short replicationFactor,
                  int shardCount,
                  int backlogDuration)

Create a new stream.

Parameters:

stream - the name of the stream

replicationFactor - replication factor of the stream

shardCount - number of shards in the stream

backlogDuration - backlog duration(in seconds) of the stream

createStream

void createStream(Stream stream)

Create a new stream.

Parameters:

stream - Stream Object, you should use Stream.Builder to build it.

listShards

List<Shard> listShards(String streamName)

List shards in a stream.

Parameters:

streamName - the name of the stream

Returns:

a list of Shards.

deleteStream

void deleteStream(String stream)

Delete the specified stream with streamName.

Parameters:

stream - the name of stream

deleteStream

void deleteStream(String stream,
                  boolean force)

Delete the specified stream with streamName.

Parameters:

stream - the name of stream

force - the flag whether to enable force deletion

listStreams

List<Stream> listStreams()

List all streams.

Returns:

a list of Streams

getStream

GetStreamResponse getStream(String streamName)

createSubscription

void createSubscription(Subscription subscription)

Create a new Subscription.

Parameters:

subscription - Subscription

listSubscriptions

List<Subscription> listSubscriptions()

List all subscriptions.

Returns:

a list of Subscriptions.

getSubscription

GetSubscriptionResponse getSubscription(String subscriptionId)

deleteSubscription

void deleteSubscription(String subscriptionId)

Delete the specified subscription with subscriptionId.

Parameters:

subscriptionId - the id of the subscription to be deleted

deleteSubscription

void deleteSubscription(String subscriptionId,
                        boolean force)

Delete the specified subscription with subscriptionId.

Parameters:

subscriptionId - the id of the subscription to be deleted

force - the flag whether to enable force deletion

describeCluster

Cluster describeCluster()

createQuery

Query createQuery(String name,
                  String sql)

listQueries

List<Query> listQueries()

getQuery

Query getQuery(String name)

deleteQuery

void deleteQuery(String name)

terminateQuery

void terminateQuery(String name)

listViews

List<View> listViews()

getView

View getView(String name)

deleteView

void deleteView(String name)

executeViewQuery

List<HRecord> executeViewQuery(String sql)

only support to execute view query, e.g. `select * from view1 where id = 1;`

Parameters:

sql - select view sql

Returns:

all HRecord result set

listConsumers

List<ConsumerInformation> listConsumers(String subscriptionId)

createConnector

Connector createConnector(CreateConnectorRequest request)

listConnectors

List<Connector> listConnectors()

getConnector

Connector getConnector(String name)

getConnectorSpec

String getConnectorSpec(String type,
                        String target)

getConnectorLogs

String getConnectorLogs(String name,
                        int begin,
                        int count)

alterConnectorConfig

void alterConnectorConfig(String name,
                          String config)

deleteConnector

void deleteConnector(String name)

getTailRecordId

String getTailRecordId(String streamName,
                       long shardId)

trimShards

void trimShards(String stream,
                List<String> records)