Skip to main content
Version: Next

Bucket Module

Message types for the Bucket API

QuotaType

class QuotaType(Enum)

determines if database has a fixed size

BucketSettings

class BucketSettings(BaseModel)

Configuration for a bucket

max_block_size

max block size in bytes

max_block_records

max number of records in a block

quota_type

quota type

quota_size

quota size in bytes

BucketInfo

class BucketInfo(BaseModel)

Information about each bucket

name

name of bucket

entry_count

number of entries in the bucket

size

size of bucket data in bytes

oldest_record

UNIX timestamp of the oldest record in microseconds

latest_record

UNIX timestamp of the latest record in microseconds

is_provisioned

bucket is provisioned amd you can't remove it or change its settings

EntryInfo

class EntryInfo(BaseModel)

Entry of bucket

name

name of entry

size

size of stored data in bytes

block_count

number of blocks

record_count

number of records

oldest_record

UNIX timestamp of the oldest record in microseconds

latest_record

UNIX timestamp of the latest record in microseconds

BucketFullInfo

class BucketFullInfo(BaseModel)

Information about bucket and contained entries

info

statistics about bucket

settings

settings of bucket

entries

information about entries of bucket

QueryType

class QueryType(Enum)

Query types

QUERY

query entries

REMOVE

remove entries

QueryEntry

class QueryEntry(BaseModel)

Query entry

query_type

query type

start

start time in microseconds

stop

end time in microseconds

include

include labels. Added for backward compatibility

exclude

exclude labels. Added for backward compatibility

each_s

return a record every S seconds

each_n

return every Nth record

limit

limit the number of records returned

ttl

time to live of the query in seconds

only_meatadata

return only metadata

continuous

continuous query, it doesn't stop until the TTL is reached

when

conditional query to filter records

strict

strict mode for when clause