co.cask.cdap.data2.transaction.stream

Interface StreamAdmin

All Known Implementing Classes:

FileStreamAdmin, InMemoryStreamAdmin

public interface StreamAdmin

Method Summary

Methods

Modifier and Type	Method and Description
void	addAccess(Id.Run run, Id.Stream streamId, AccessType accessType) Record access of stream by a program run for lineage computation.
void	configureGroups(Id.Stream streamId, Map<Long,Integer> groupInfo) Sets the consumer groups information for the given stream.
void	configureInstances(Id.Stream streamId, long groupId, int instances) Sets the number of consumer instances for the given consumer group in a stream.
StreamConfig	create(Id.Stream streamId) Creates stream if doesn't exist.
StreamConfig	create(Id.Stream streamId, Properties props) Creates stream if doesn't exist.
boolean	createOrUpdateView(Id.Stream.View viewId, ViewSpecification spec) Creates or updates a stream view.
void	deleteView(Id.Stream.View viewId) Deletes a stream view.
void	drop(Id.Stream streamId) Deletes stream from the system completely.
void	dropAllInNamespace(Id.Namespace namespace) Deletes all entries for all streams within a namespace
boolean	exists(Id.Stream streamId)
StreamConfig	getConfig(Id.Stream streamId) Returns the configuration of the given stream.
ViewSpecification	getView(Id.Stream.View viewId) Gets the details of a stream view.
List<Id.Stream.View>	listViews(Id.Stream streamId) Lists views associated with a stream.
void	register(Iterable<? extends Id> owners, Id.Stream streamId) Register stream used by program.
void	truncate(Id.Stream streamId) Wipes out stream data.
void	updateConfig(Id.Stream streamId, StreamProperties properties) Overwrites existing configuration for the given stream.
void	upgrade() Performs upgrade action for all streams.
boolean	viewExists(Id.Stream.View viewId) Checks if the view exists

Method Detail

dropAllInNamespace

void dropAllInNamespace(Id.Namespace namespace)
                        throws Exception

Deletes all entries for all streams within a namespace

Throws:

Exception

configureInstances

void configureInstances(Id.Stream streamId,
                      long groupId,
                      int instances)
                        throws Exception

Sets the number of consumer instances for the given consumer group in a stream.

Parameters:

streamId - Id of the stream.

groupId - The consumer group to alter.

instances - Number of instances.

Throws:

Exception

configureGroups

void configureGroups(Id.Stream streamId,
                   Map<Long,Integer> groupInfo)
                     throws Exception

Sets the consumer groups information for the given stream.

Parameters:

streamId - Id of the stream.

groupInfo - A map from groupId to number of instances of each group.

Throws:

Exception

upgrade

void upgrade()
             throws Exception

Performs upgrade action for all streams.

Throws:

Exception

getConfig

StreamConfig getConfig(Id.Stream streamId)
                       throws IOException

Returns the configuration of the given stream.

Parameters:

streamId - Id of the stream.

Returns:

A StreamConfig instance.

Throws:

IOException - If the stream doesn't exists.

updateConfig

void updateConfig(Id.Stream streamId,
                StreamProperties properties)
                  throws IOException

Overwrites existing configuration for the given stream.

Parameters:

streamId - Id of the stream whose properties are being updated

properties - New configuration of the stream.

Throws:

IOException

exists

boolean exists(Id.Stream streamId)
               throws Exception

Parameters:

streamId - Id of the stream.

Returns:

true if stream with given Id exists, otherwise false

Throws:

Exception - if check fails

create

StreamConfig create(Id.Stream streamId)
                    throws Exception

Creates stream if doesn't exist. If stream exists does nothing.

Parameters:

streamId - Id of the stream to create

Returns:

The StreamConfig associated with the new stream

Throws:

Exception - if creation fails

create

StreamConfig create(Id.Stream streamId,
                  @Nullable
                  Properties props)
                    throws Exception

Creates stream if doesn't exist. If stream exists, does nothing.

Parameters:

streamId - Id of the stream to create

props - additional properties

Returns:

The StreamConfig associated with the new stream

Throws:

Exception - if creation fails

truncate

void truncate(Id.Stream streamId)
              throws Exception

Wipes out stream data.

Parameters:

streamId - Id of the stream to truncate

Throws:

Exception - if cleanup fails

drop

void drop(Id.Stream streamId)
          throws Exception

Deletes stream from the system completely.

Parameters:

streamId - Id of the stream to delete

Throws:

Exception - if deletion fails

createOrUpdateView

boolean createOrUpdateView(Id.Stream.View viewId,
                         ViewSpecification spec)
                           throws Exception

Creates or updates a stream view.

Parameters:

viewId - the view

spec - specification for the view

Returns:

true if a stream view was created

Throws:

Exception

deleteView

void deleteView(Id.Stream.View viewId)
                throws Exception

Deletes a stream view.

Parameters:

viewId - the view

Throws:

Exception

listViews

List<Id.Stream.View> listViews(Id.Stream streamId)
                               throws Exception

Lists views associated with a stream.

Parameters:

streamId - the stream

Returns:

the associated views

Throws:

Exception

getView

ViewSpecification getView(Id.Stream.View viewId)
                          throws Exception

Gets the details of a stream view.

Parameters:

viewId - the view

Returns:

the details of the view

Throws:

Exception

viewExists

boolean viewExists(Id.Stream.View viewId)
                   throws Exception

Checks if the view exists

Parameters:

viewId - the view

Returns:

boolean which is true if view exists else false

Throws:

Exception

register

void register(Iterable<? extends Id> owners,
            Id.Stream streamId)

Register stream used by program.

Parameters:

owners - the ids that are using the stream

streamId - the stream being used

addAccess

void addAccess(Id.Run run,
             Id.Stream streamId,
             AccessType accessType)

Record access of stream by a program run for lineage computation.

Parameters:

run - program run

streamId - stream being accessed

accessType - type of access