stdb-driver 0.4.0

Mireo SpaceTime database connector

Mireo SpaceTime database remote connector

stdb-driver is a Python module for managing a Mireo SpaceTime database.

Features

• Both blocking and asynchronous modes of operation.
• Listing nodes; listing, creating, and dropping tables; inserting rows; and executing range queries.
• Range query results are convertible to Python lists, NumPy arrays, and Pandas dataframes.
• Type stubs included — full IDE autocompletion and type checking.
• Requires CPython 3.10+.
• Available for Linux (glibc 2.17+ and musl 1.2+; x86-64 and arm64) and Windows (x86-64 and arm64).

Installation

pip install -U stdb-driver

Conversions to NumPy or Pandas data types require optional dependencies:

pip install -U stdb-driver[numpy]
pip install -U stdb-driver[pandas]

Install optional dependencies for all available conversions:

pip install -U stdb-driver[convert]

Install all optional dependencies using:

pip install -U stdb-driver[all]

Example

import stdb_driver

# Connect (conn_str is a ZooKeeper connection string)
session = stdb_driver.SessionConfig(<conn_str>).build()
print(session.status())  # SessionStatus.Connected

# List live nodes and table schemas in the cluster
print(session.list_nodes())
print(session.list_tables())

# Run a range query — one hyperrectangle per row, RANGE_ALL = unbounded dimension
RALL = stdb_driver.RANGE_ALL
res = session.range_query('segment', [[(1, 10000), RALL, RALL, RALL, RALL, RALL, RALL, RALL, RALL]])

# Print column names, MSQL data types, and nullability
print(res.row_type.columns)

# Iterating over rows lazily converts each to a tuple of native Python types
for row in res:
    print(row)

# Or convert the whole result at once:
rows = res.to_list()  # list of tuples of native Python types
arr = res.to_numpy()  # NumPy array (requires numpy)
df = res.to_pandas()  # Pandas dataframe (requires pandas)

# Disconnect
session.stop()
print(session.status())  # SessionStatus.SessionEnded

License

Licensed under BSD 3-Clause "New" or "Revised" License.

Credits

Authored and maintained by Mireo.