Welcome to ClockworkDB’s documentation!

Here you will find all the information you need to get started with ClockworkDB, including installation instructions, a quick start guide, and detailed API documentation.

Contents:

• Getting Started
• Configuring ClockworkDB
• Managing Configuration Files
• Command-Line Utilities
  • List Repositories
  • List Datastores
  • Catalog Datastores
  • Timeseries/Vector Meta Data
  • Timeseries/Vector Data
  • Migrating Data
  • Logging from Scripts
  • Other Utilities
• Sample Node.js Programs
  • List configured Repositories
  • List Repository Datastores
  • Catalog a Datastore
  • Display timeseries/vector metadata
  • Display timeseries/vector data
• API Reference
  • Engine
    • Engine.getProvider()
    • Engine.getRepositories()
    • Engine.getSession()
    • Engine.toString()
    • Engine.version()
    • Engine.Instance()
  • Provider
    • Provider.bugReport()
    • Provider.description()
    • Provider.name()
    • Provider.toString()
    • Provider.tsdbVersion()
    • Provider.version()
    • Provider.xmlConfigTemplate()
  • Session
    • Session.getConnection()
    • Session.getProvider()
    • Session.name()
    • Session.toString()
  • Connection
    • Connection.deleteDatastore()
    • Connection.getDatastore()
    • Connection.getDatastores()
    • Connection.getSession()
    • Connection.toString()
  • Datastore
    • Datastore.close()
    • Datastore.deleteTimeSeries()
    • Datastore.getConnection()
    • Datastore.getCreateDateTime()
    • Datastore.getDescription()
    • Datastore.getDocumentation()
    • Datastore.getMode()
    • Datastore.getModifyDateTime()
    • Datastore.getName()
    • Datastore.getTimeSeries()
    • Datastore.hasTimeSeries()
    • Datastore.isOpen()
    • Datastore.regexNameSearch()
    • Datastore.saveTimeSeries()
    • Datastore.setDescription()
    • Datastore.setDocumentation()
    • Datastore.toString()
  • TimeSeries
    • TimeSeries.exists()
    • TimeSeries.fullRange()
    • TimeSeries.getAttribute()
    • TimeSeries.getCalendar()
    • TimeSeries.getCreateDateTime()
    • TimeSeries.getDatastore()
    • TimeSeries.getFirstDate()
    • TimeSeries.getFirstDateInt()
    • TimeSeries.getLastDate()
    • TimeSeries.getLastDateInt()
    • TimeSeries.getModifyDateTime()
    • TimeSeries.getName()
    • TimeSeries.getObservation()
    • TimeSeries.isSparseSeries()
    • TimeSeries.name()
    • TimeSeries.print()
    • TimeSeries.range()
    • TimeSeries.save()
    • TimeSeries.setAttribute()
    • TimeSeries.toString()
  • ContinuousRange
    • ContinuousRange.getIterator()
    • ContinuousRange.timeSeries()
    • ContinuousRange.toString()
  • ContinuousRangeIterator
    • ContinuousRangeIterator.getObservation()
    • ContinuousRangeIterator.hasNext()
    • ContinuousRangeIterator.next()
    • ContinuousRangeIterator.toString()
  • DatedObservation
    • DatedObservation.date()
    • DatedObservation.dateAsString()
    • DatedObservation.dateInt()
    • DatedObservation.isNormal()
    • DatedObservation.observation()
    • DatedObservation.toBool()
    • DatedObservation.toDouble()
    • DatedObservation.toFloat()
    • DatedObservation.toInt()
    • DatedObservation.toString()
    • DatedObservation.toStringValue()
  • RepositoryMetaData
    • RepositoryMetaData.description()
    • RepositoryMetaData.module()
    • RepositoryMetaData.name()
    • RepositoryMetaData.toString()
  • RepositoryMetaDataVector
    • RepositoryMetaDataVector.get()
    • RepositoryMetaDataVector.getIterator()
    • RepositoryMetaDataVector.toString()
  • RepositoryMetaDataVectorIterator
    • RepositoryMetaDataVectorIterator.hasNext()
    • RepositoryMetaDataVectorIterator.next()
    • RepositoryMetaDataVectorIterator.toString()
  • DatastoreMatch
    • DatastoreMatch.name()
    • DatastoreMatch.next()
    • DatastoreMatch.toString()
  • DatastoreMetaData
    • DatastoreMetaData.path()
    • DatastoreMetaData.toString()
  • DatastoresMetaDataVector
    • DatastoresMetaDataVector.get()
    • DatastoresMetaDataVector.getIterator()
    • DatastoresMetaDataVector.size()
    • DatastoresMetaDataVector.toString()
  • DatastoresMetaDataVectorIterator
    • DatastoresMetaDataVectorIterator.hasNext()
    • DatastoresMetaDataVectorIterator.next()
    • DatastoresMetaDataVectorIterator.toString()
  • Observation
    • Observation.equals()
    • Observation.isNormal()
    • Observation.notEquals()
    • Observation.set()
    • Observation.toBool()
    • Observation.toDouble()
    • Observation.toFloat()
    • Observation.toInt()
    • Observation.toString()
  • Double
    • Double.equals()
    • Double.isNormal()
    • Double.notEquals()
    • Double.set()
    • Double.toBool()
    • Double.toDouble()
    • Double.toFloat()
    • Double.toInt()
    • Double.toString()
    • Double.value()
  • Float
    • Float.equals()
    • Float.isNormal()
    • Float.notEquals()
    • Float.set()
    • Float.toBool()
    • Float.toDouble()
    • Float.toFloat()
    • Float.toInt()
    • Float.toString()
    • Float.value()
  • Int
    • Int.equals()
    • Int.isNormal()
    • Int.notEquals()
    • Int.set()
    • Int.toBool()
    • Int.toDouble()
    • Int.toFloat()
    • Int.toInt()
    • Int.toString()
    • Int.value()
  • String
    • String.equals()
    • String.isNormal()
    • String.notEquals()
    • String.set()
    • String.toBool()
    • String.toDouble()
    • String.toFloat()
    • String.toInt()
    • String.toString()
    • String.value()
  • Bool
    • Bool.equals()
    • Bool.isNormal()
    • Bool.notEquals()
    • Bool.set()
    • Bool.toBool()
    • Bool.toDouble()
    • Bool.toFloat()
    • Bool.toInt()
    • Bool.toString()
    • Bool.value()
  • Date
    • Date.day()
    • Date.month()
    • Date.toString()
    • Date.year()
  • DateTime
    • DateTime.date()
    • DateTime.toString()

Indices and tables

• Index

• Module Index

• Search Page