Package org.yamcs.yarch

Class YarchDatabaseInstance

java.lang.Object

org.yamcs.yarch.YarchDatabaseInstance

public class YarchDatabaseInstance
extends Object

Handles tables and streams for one Yamcs Instance

Synchronisation policy: to avoid problems with stream disappearing when clients connect to them, all the creation/closing/subscription to streams/tables shall be done while acquiring a lock on the YarchDatabase object. This is done in the StreamSqlStatement.java

Delivery of tuples does not require locking, this means subscription can change while delivering (for that a concurrent list is used in Stream.java)

Field Summary

Fields

Modifier and Type	Field	Description
static String	PART_CONF_KEY

Method Summary

Modifier and Type	Method	Description
FileSystemBucket	addFileSystemBucket(String bucketName, Path location)	Adds a bucket that maps to the file system.
static void	addSpec(Spec spec)
void	addStream(Stream stream)	Adds a stream to the dictionary making it "official"
void	close()
Bucket	createBucket(String bucketName)
StreamSqlStatement	createStatement(String query, Object... args)
void	createTable(TableDefinition tbldef)	add a table to the dictionary throws exception if a table or a stream with the same name already exist
void	deleteBucket(String bucketName)
void	dropTable(String tblName)
StreamSqlResult	execute(String query, Object... args)	Executes a query and returns a result.
StreamSqlResult	execute(StreamSqlStatement stmt)
void	execute(StreamSqlStatement stmt, ResultListener resultListener)
void	execute(StreamSqlStatement stmt, ResultListener resultListener, long limit)
void	executeDiscardingResult(String query, Object... args)
StreamSqlResult	executeUnchecked(String query, Object... args)	Same as execute(String, Object...) but it embeds any exception into a YarchException
StreamSqlResult	executeUnchecked(StreamSqlStatement stmt)	Same as execute(StreamSqlStatement) but it embeds any exception into a YarchException
Bucket	getBucket(String bucketName)
TimePartitionSchema	getDefaultPartitioningSchema()	Return the time partitioning schema configured (dataPartitioningByTime) if any.
String	getName()
PartitionManager	getPartitionManager(TableDefinition tblDef)
ProtobufDatabase	getProtobufDatabase()
String	getRoot()	Returns the root directory for this database instance.
Sequence	getSequence(String name, boolean create)
List<SequenceInfo>	getSequencesInfo()
StorageEngine	getStorageEngine(TableDefinition tbldef)
Stream	getStream(String name)
Collection<Stream>	getStreams()
TableDefinition	getTable(String name)
Collection<TableDefinition>	getTableDefinitions()
String	getTablespaceName()	Tablespaces are used by RdbStorageEngine to store data.
TimePartitionSchema	getTimePartitioningSchema(YConfiguration config)	Get the time partitioning schema configured in the passed config, or the instance schema
String	getYamcsInstance()
List<Bucket>	listBuckets()
void	removeStream(String name)
void	renameTable(String name, String newName)
boolean	streamOrTableExists(String name)

Methods inherited from class java.lang.Object

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

Field Details

PART_CONF_KEY

public static String PART_CONF_KEY

Method Details

getPartitionManager

public PartitionManager getPartitionManager(TableDefinition tblDef)

getTablespaceName

public String getTablespaceName()

Tablespaces are used by RdbStorageEngine to store data. Returns the default tablespace name that is used by all tables and also the parameter archive of this yamcs instance

getName

public String getName()

Returns:

the instance name

getYamcsInstance

public String getYamcsInstance()

createTable

public void createTable(TableDefinition tbldef)
                 throws YarchException

add a table to the dictionary throws exception if a table or a stream with the same name already exist

Parameters:

tbldef - - table definition

Throws:

YarchException - - thrown in case a table or a stream with the same name already exists or if there was an error in creating the table

addStream

public void addStream(Stream stream)
               throws YarchException

Adds a stream to the dictionary making it "official"

Parameters:

stream -

Throws:

YarchException

renameTable

public void renameTable(String name,
 String newName)

getTable

public TableDefinition getTable(String name)

streamOrTableExists

public boolean streamOrTableExists(String name)

getStream

public Stream getStream(String name)

dropTable

public void dropTable(String tblName)

removeStream

public void removeStream(String name)

getStorageEngine

public StorageEngine getStorageEngine(TableDefinition tbldef)

getStreams

public Collection<Stream> getStreams()

getTableDefinitions

public Collection<TableDefinition> getTableDefinitions()

getRoot

public String getRoot()

Returns the root directory for this database instance. It is usually home/instance_name.

createStatement

public StreamSqlStatement createStatement(String query,
 Object... args)
                                   throws StreamSqlException,
ParseException

Throws:

StreamSqlException

ParseException

execute

public void execute(StreamSqlStatement stmt,
 ResultListener resultListener,
 long limit)
             throws StreamSqlException

Throws:

StreamSqlException

execute

public void execute(StreamSqlStatement stmt,
 ResultListener resultListener)
             throws StreamSqlException

Throws:

StreamSqlException

execute

public StreamSqlResult execute(StreamSqlStatement stmt)
                        throws StreamSqlException

Throws:

StreamSqlException

execute

public StreamSqlResult execute(String query,
 Object... args)
                        throws StreamSqlException,
ParseException

Executes a query and returns a result.

If the result contains streaming data (select from table or stream) you have to close the result

Parameters:

query -

args -

Returns:

Throws:

StreamSqlException

ParseException

executeUnchecked

public StreamSqlResult executeUnchecked(StreamSqlStatement stmt)

Same as execute(StreamSqlStatement) but it embeds any exception into a YarchException

executeUnchecked

public StreamSqlResult executeUnchecked(String query,
 Object... args)

Same as execute(String, Object...) but it embeds any exception into a YarchException

Parameters:

query -

args -

Returns:

executeDiscardingResult

public void executeDiscardingResult(String query,
 Object... args)
                             throws StreamSqlException,
ParseException

Throws:

StreamSqlException

ParseException

close

public void close()

getProtobufDatabase

public ProtobufDatabase getProtobufDatabase()
                                     throws YarchException

Throws:

YarchException

getDefaultPartitioningSchema

public TimePartitionSchema getDefaultPartitioningSchema()

Return the time partitioning schema configured (dataPartitioningByTime) if any.

If not configured, return null.

getBucket

public Bucket getBucket(String bucketName)
                 throws IOException

Throws:

IOException

createBucket

public Bucket createBucket(String bucketName)
                    throws IOException

Throws:

IOException

addFileSystemBucket

public FileSystemBucket addFileSystemBucket(String bucketName,
 Path location)
                                     throws IOException

Adds a bucket that maps to the file system. This is a transient operation that has to be done on each server restart.

Parameters:

bucketName - the name of the bucket

location - the path to the bucket contents

Returns:

the created bucket

Throws:

IOException - on I/O issues

listBuckets

public List<Bucket> listBuckets()
                         throws IOException

Throws:

IOException

deleteBucket

public void deleteBucket(String bucketName)
                  throws IOException

Throws:

IOException

getSequence

public Sequence getSequence(String name,
 boolean create)
                     throws YarchException

Throws:

YarchException

getSequencesInfo

public List<SequenceInfo> getSequencesInfo()

addSpec

public static void addSpec(Spec spec)

getTimePartitioningSchema

public TimePartitionSchema getTimePartitioningSchema(YConfiguration config)

Get the time partitioning schema configured in the passed config, or the instance schema

returns null of "none" is configured in the config or if there is no configuration in the config or at instance level