DOCSEARCHbyAlgolia
Submit Docs

Deltix QSRV API Documentation

website·Indexed 32 days ago

https://kb.timebase.info/

Technical API reference for deltix.qsrv and deltix.util components. Includes documentation for high-frequency (hf) tickdb, solgen for C++, Python, and Java, as well as utilities for JSON parsing, networking, and security. Features detailed class hierarchies, interface definitions, and specific implementations such as TDBRunner and JavaBeanGenerator.

Tokens
740.7K
Snippets
4.1K
Records
6.1K
Agent score
56%

What's inside Deltix QSRV

  1. Overview of TimeBase Cluster capabilities

    TimeBase Cluster allows a group of TimeBase servers (called Members) to be organized into a logical cluster. This architecture is used to handle datasets that exceed the capacity of a single machine, prevent data loss, and scale the processing of high volumes of incoming and outgoing data. TimeBase Cluster is available exclusively in the TimeBase Enterprise Edition. It utilizes the Raft consensus algorithm to elect a cluster leader, maintain a quorum to avoid split-brain scenarios, and replicate common metadata and data locations across all members.

  3. Overview of QuantQuery Language (QQL)

    QuantQuery Language (QQL) is a query language used in TimeBase Enterprise Edition 5.4 and earlier to extract, filter, aggregate, and transform data in TimeBase streams. While similar to SQL, QQL is specifically designed for polymorphic time-series data, whereas SQL is intended for monomorphic (fixed-structure) data.

  4. Overview of deltix.qsrv.hf.pub.util package

    The deltix.qsrv.hf.pub.util package provides utility classes and interfaces for handling live cursor watching and serialization. Key components include LiveCursorWatcher for monitoring cursors, LiveCursorWatcherEx for automated cursor closing, and SerializationUtils for serialization tasks.

  5. Overview of TimeBase Load Simulator

    The TimeBase Load Simulator is a console utility used to test TimeBase performance by simulating various load scenarios over a defined time period. It connects to an existing TimeBase instance, executes the simulation, and then stops. Users can monitor the resulting system metrics in Grafana.

    Supported load scenarios include:

    • Data connectors: Loading market data to n streams at a fixed rate for a specific number of symbols.
    • Live cursors: Reading live data from n random streams.
    • Live cursors (all streams): Reading live data from all available streams.
    • Historical cursors: Reading random data from a random stream starting from a random timestamp.
    • Extra streams: Creating n additional streams prior to simulation.

  7. Overview of deltix.qsrv.testsetup class hierarchy

    The deltix.qsrv.testsetup package provides utilities for test data generation and setup. Key classes include BaseGenerator (which implements MessageSource) and its subclass DataGenerator, the CycleIterator for iterating over sets of data, and TickDBCreator for creating tick databases. It also provides specialized message types for testing, such as FloatMessage, IntMessage, and StringMessage, all of which extend InstrumentMessage.

  8. Overview of TimeBase Web Administrator

    TimeBase Web Administrator is a web interface used to manage and monitor data stored in TimeBase. Its primary capabilities include creating, editing, viewing, deleting, exporting, and importing streams, as well as monitoring live data and querying data. Additionally, it functions as a REST/WS gateway for the TimeBase Server.

  9. Overview of TimeBase Data Partitions (Spaces)

    Data Partitions, known as spaces, allow developers to physically distribute Time Slice Files (TSF) based on time ranges or other criteria. This approach maximizes writing performance by increasing throughput and allowing multiple loaders to write concurrently to specific spaces without impacting reading performance. Chronological order is preserved within spaces. By default, all data is written into a NULL space. A new space is created automatically the first time data is written to it; empty spaces cannot be created.

  10. Overview of the DataType class hierarchy

    The deltix.qsrv.hf.pub.md.DataType class is a public abstract class that implements java.io.Serializable and java.lang.Cloneable. It serves as the base class for various specialized data type implementations used in the system.

  11. Overview of the deltix.qsrv.hf.pub.codec.intp package hierarchy

    The deltix.qsrv.hf.pub.codec.intp package contains implementations for encoding and decoding logic, including various bound and unbound encoders/decoders, field codecs, and value accessors. Key components include:

    • Encoders/Decoders: Implementations for BoundDecoder, FixedBoundEncoder, FixedExternalDecoder, UnboundDecoder, and PolyBoundEncoder.
    • Field Handling: FieldEncoder (with ClassFieldEncoder) and FieldDecoder (with ClassFieldDecoder).
    • Value Access: ValueGetter and ValueSetter interfaces with Java-based implementations (JavaValueGetter, JavaValueSetterMethod, etc.).
    • Contexts: DecodingContext and EncodingContext for managing state during codec operations.