API Reference

class Engine()

Engine

The Engine is the entry point to ClockworkDB. Get a reference by calling Instance().

exported from clockworkdb.d

Engine.getProvider()

Get the default provider used to manage persistence for ClockworkDB for a configured repository. const repoProvider = engine.getProvider();

Returns:: Provider

Engine.getRepositories()

Get a vector containing RepositoryMetaData objects for each repository.

Returns:: RepositoryMetaDataVector

Engine.getSession(repositoryName)

Arguments:

repositoryName (string) – Get the Session for the named repository.

Returns:

Session

Engine.toString()

String representation of the Engine.

Returns:: string

Engine.version()

Get the version of ClockworkDB in use.

Returns:: string

static Engine.Instance()

Returns:: Engine

class Provider()

Module used to provide persistence management.(SO|DLL)

exported from clockworkdb.d

Provider.bugReport()

Where you can submit bug reports

Returns:: string

Provider.description()

Description of the Provider

Returns:: string

Provider.name()

Name of the Provider

Returns:: string

Provider.toString()

String representation of the Provider

Returns:: string

Provider.tsdbVersion()

ClockworkDB Version

Returns:: string

Provider.version()

Provider Version

Returns:: string

Provider.xmlConfigTemplate()

A default configuration file for the Provider. A good place to start.

Returns:: string

class Session()

Session class in the parent manager for a repository. Repositories can use only one Provider.: You may have numerous repositories with different Providers and corresponding Sessions. You can use data across numerous repositories without concern for the Provider.

exported from clockworkdb.d

Session.getConnection()

Get a Connection. This is an abstraction that isolates client/server connections.: Some Providers are embedded and this will be close to a no-op.

Returns:: Connection

Session.getProvider()

Get the Provider that is managing persistence for this session.

Returns:: Provider

Session.name()

Get the name of this session.

Returns:: string

Session.toString()

String reprosentation of the Session.

Returns:: string

class Connection()

exported from clockworkdb.d

Connection.deleteDatastore(name)

Arguments:

name (string)

Connection.getDatastore(name, mode)

Arguments:

name (string)
mode (AccessMode)

Returns:

Datastore

Connection.getDatastores()

Returns:: DatastoresMetaDataVector

Connection.getSession()

Returns:: Session

Connection.toString()

Returns:: string

class Datastore()

exported from clockworkdb.d

Datastore.close()

Datastore.deleteTimeSeries(name)

Arguments:

name (string)

Datastore.getConnection()

Returns:: Connection

Datastore.getCreateDateTime()

Returns:: DateTime

Datastore.getDescription()

Returns:: string

Datastore.getDocumentation()

Returns:: string

Datastore.getMode()

Returns:: AccessMode

Datastore.getModifyDateTime()

Returns:: DateTime

Datastore.getName()

Returns:: string

Datastore.getTimeSeries(name)

Arguments:

name (string)

Returns:

TimeSeries

Datastore.hasTimeSeries(name)

Arguments:

name (string)

Returns:

boolean

Datastore.isOpen()

Returns:: boolean

Datastore.regexNameSearch(regex)

Arguments:

regex (string)

Returns:

DatastoreMatch

Datastore.saveTimeSeries(object)

Arguments:

object (TimeSeries)

Datastore.setDescription(description)

Arguments:

description (string)

Datastore.setDocumentation(documentation)

Arguments:

documentation (string)

Datastore.toString()

toString

Returns:: string

class TimeSeries()

exported from clockworkdb.d

TimeSeries.exists()

Returns:: boolean

TimeSeries.fullRange()

Returns:: ContinuousRange

TimeSeries.getAttribute(attrName)

Arguments:

attrName (string)

Returns:

string

TimeSeries.getCalendar()

Returns:: Calendar

TimeSeries.getCreateDateTime()

Returns:: DateTime

TimeSeries.getDatastore()

Returns:: Datastore

TimeSeries.getFirstDate()

Returns:: Date

TimeSeries.getFirstDateInt()

Returns:: number

TimeSeries.getLastDate()

Returns:: Date

TimeSeries.getLastDateInt()

Returns:: number

TimeSeries.getModifyDateTime()

Returns:: DateTime

TimeSeries.getName()

Returns:: string

TimeSeries.getObservation(date)

Arguments:

date (Date)

Returns:

Observation

TimeSeries.isSparseSeries()

Returns:: boolean

TimeSeries.name()

Returns:: string

TimeSeries.print()

TimeSeries.range(firstDate, lastDate)

Arguments:

firstDate (Date)
lastDate (Date)

Returns:

ContinuousRange

TimeSeries.save()

TimeSeries.setAttribute(attributeName, value)

Arguments:

attributeName (string)
value (string)

TimeSeries.toString()

Returns:: string

class ContinuousRange()

exported from clockworkdb.d

ContinuousRange.getIterator()

Returns:: ContinuousRangeIterator

ContinuousRange.timeSeries()

Returns:: TimeSeries

ContinuousRange.toString()

Returns:: string

class ContinuousRangeIterator()

exported from clockworkdb.d

ContinuousRangeIterator.getObservation()

Returns:: Observation

ContinuousRangeIterator.hasNext()

Returns:: boolean

ContinuousRangeIterator.next()

Returns:: DatedObservation

ContinuousRangeIterator.toString()

Returns:: string

class DatedObservation()

exported from clockworkdb.d

DatedObservation.date()

Returns:: Date

DatedObservation.dateAsString()

Returns:: string

DatedObservation.dateInt()

Returns:: number

DatedObservation.isNormal()

Returns:: boolean

DatedObservation.observation()

Returns:: Observation

DatedObservation.toBool()

Returns:: boolean

DatedObservation.toDouble()

Returns:: number

DatedObservation.toFloat()

Returns:: number

DatedObservation.toInt()

Returns:: number

DatedObservation.toString()

Returns:: string

DatedObservation.toStringValue()

Returns:: string

class RepositoryMetaData()

exported from clockworkdb.d

RepositoryMetaData.description()

Returns:: string

RepositoryMetaData.module()

Returns:: string

RepositoryMetaData.name()

Returns:: string

RepositoryMetaData.toString()

Returns:: string

class RepositoryMetaDataVector()

exported from clockworkdb.d

RepositoryMetaDataVector.get(ix)

Get the RepositoryMetaData item at a given index.

Arguments:

ix (number)

Returns:

RepositoryMetaData

RepositoryMetaDataVector.getIterator()

An iterator mainly used for “for( const repo of repos) { … }”

Returns:: RepositoryMetaDataVectorIterator

RepositoryMetaDataVector.toString()

Returns:: string

class RepositoryMetaDataVectorIterator()

RepositoryMetaDataVectorIterator

exported from clockworkdb.d

RepositoryMetaDataVectorIterator.hasNext()

Returns:: boolean

RepositoryMetaDataVectorIterator.next()

Returns:: RepositoryMetaData

RepositoryMetaDataVectorIterator.toString()

Returns:: string

class DatastoreMatch()

exported from clockworkdb.d

DatastoreMatch.name()

Returns:: string

DatastoreMatch.next()

Returns:: boolean

DatastoreMatch.toString()

Returns:: string

class DatastoreMetaData()

DatastoreMetaData

exported from clockworkdb.d

DatastoreMetaData.path()

Returns:: string

DatastoreMetaData.toString()

Returns:: string

class DatastoresMetaDataVector()

exported from clockworkdb.d

DatastoresMetaDataVector.get(index)

Arguments:

index (number)

Returns:

DatastoreMetaData

DatastoresMetaDataVector.getIterator()

Returns:: DatastoresMetaDataVectorIterator

DatastoresMetaDataVector.size()

Returns:: number

DatastoresMetaDataVector.toString()

Returns:: string

class DatastoresMetaDataVectorIterator()

exported from clockworkdb.d

DatastoresMetaDataVectorIterator.hasNext()

Returns:: boolean

DatastoresMetaDataVectorIterator.next()

Returns:: DatastoreMetaData

DatastoresMetaDataVectorIterator.toString()

Returns:: string

class Observation()

exported from clockworkdb.d

Observation.equals(observation)

Arguments:

observation (Observation)

Returns:

boolean

Observation.isNormal()

Returns:: boolean

Observation.notEquals(observation)

Arguments:

observation (Observation)

Returns:

boolean

Observation.set(observation)

Arguments:

observation (Observation)

Observation.toBool()

Returns:: boolean

Observation.toDouble()

Returns:: number

Observation.toFloat()

Returns:: number

Observation.toInt()

Returns:: number

Observation.toString()

Returns:: string

class Double()

Double

exported from clockworkdb.d

Extends:

Observation

Double.equals(observation)

equals

Arguments:

observation (Observation)

Returns:

boolean

Double.isNormal()

Returns:: boolean

Double.notEquals(observation)

Arguments:

observation (Observation)

Returns:

boolean

Double.set(observation)

Arguments:

observation (Observation)

Double.toBool()

Returns:: boolean

Double.toDouble()

Returns:: number

Double.toFloat()

Returns:: number

Double.toInt()

Returns:: number

Double.toString()

Returns:: string

Double.value()

Returns:: number

class Float()

exported from clockworkdb.d

Extends:

Observation

Float.equals(observation)

Arguments:

observation (Observation)

Returns:

boolean

Float.isNormal()

isNormal

Returns:: boolean

Float.notEquals(observation)

Arguments:

observation (Observation)

Returns:

boolean

Float.set(observation)

Arguments:

observation (Observation)

Float.toBool()

Returns:: boolean

Float.toDouble()

Returns:: number

Float.toFloat()

Returns:: number

Float.toInt()

Returns:: number

Float.toString()

Returns:: string

Float.value()

value

Returns:: number

class Int()

exported from clockworkdb.d

Extends:

Observation

Int.equals(observation)

equals

Arguments:

observation (Observation)

Returns:

boolean

Int.isNormal()

Returns:: boolean

Int.notEquals(observation)

Arguments:

observation (Observation)

Returns:

boolean

Int.set(observation)

Arguments:

observation (Observation)

Int.toBool()

Returns:: boolean

Int.toDouble()

Returns:: number

Int.toFloat()

Returns:: number

Int.toInt()

Returns:: number

Int.toString()

Returns:: string

Int.value()

Returns:: number

class String()

exported from clockworkdb.d

Extends:

Observation

String.equals(observation)

Arguments:

observation (Observation)

Returns:

boolean

String.isNormal()

Returns:: boolean

String.notEquals(observation)

Arguments:

observation (Observation)

Returns:

boolean

String.set(observation)

Arguments:

observation (Observation)

String.toBool()

Returns:: boolean

String.toDouble()

Returns:: number

String.toFloat()

Returns:: number

String.toInt()

Returns:: number

String.toString()

Returns:: string

String.value()

Returns:: boolean

class Bool()

exported from clockworkdb.d

Extends:

Observation

Bool.equals(observation)

Arguments:

observation (Observation)

Returns:

boolean

Bool.isNormal()

Returns:: boolean

Bool.notEquals(observation)

Arguments:

observation (Observation)

Returns:

boolean

Bool.set(observation)

Arguments:

observation (Observation)

Bool.toBool()

Returns:: boolean

Bool.toDouble()

Returns:: number

Bool.toFloat()

Returns:: number

Bool.toInt()

Returns:: number

Bool.toString()

Returns:: string

Bool.value()

Returns:: boolean

class Date(year, month, day)

exported from clockworkdb.d

Arguments:

year (number)
month (number)
day (number)

Date.day()

Returns:: number

Date.month()

Returns:: number

Date.toString()

Returns:: string

Date.year()

Returns:: number

class DateTime(year, month, day, hour, minute, second)

exported from clockworkdb.d

Arguments:

year (number)
month (number)
day (number)
hour (number)
minute (number)
second (number)

DateTime.date()

Returns:: Date

DateTime.toString()

Returns:: string