thrift.data.thrift Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of concourse Show documentation

This is the api to interact with Concourse, a schemaless and distributed version control database with optimistic availability, serializable transactions and full-text search. Concourse provides a more intuitive approach to data management that is easy to deploy, access and scale with minimal tuning while also maintaining the referential integrity and ACID characteristics of traditional database systems.

There is a newer version: 0.4.4

Show newest version

# This file contains "data" definitions that likely have been modified
# post thrift generation. Therefore, it is advisable to compare any
# regenerated versions of these structs with previous versions to
# make sure that any additional custom logic is retained.
#
# To generate java source code run:
# thrift -out ../../java -gen java data.thrift

include "shared.thrift"

namespace java org.cinchapi.concourse.thrift

/**
 * A lightweight wrapper for a typed Object that has been encoded
 * as binary data.
 */
struct TObject {
	1:required binary data,
	2:required shared.Type type = shared.Type.STRING
}

/**
 * A representation for an enum that declares the type of a TSymbol.
 */
enum TSymbolType {
	CONJUNCTION = 1,
    KEY = 2,
    VALUE = 3,
    PARENTHESIS = 4,
    OPERATOR = 5,
    TIMESTAMP = 6
}

/**
 * A representation for a Symbol that can be passed over the wire via
 * Thrift. Once passed over the wire, the server uses information
 * about the symbol type to parse the string representation of the
 * symbol to an actual object.
 */
struct TSymbol {
    1:required TSymbolType type;
    2:required string symbol;
}

/**
 * A representation for a Criteria that can be passed over the wire via
 * Thrift. Once passed over the write, the server goes through the list
 * of TSymbols and converts them to actual Symbol objects which can then
 * be used in the shunting-yard algorithm.
 */
struct TCriteria {
    1:required list symbols
}