msql-driver 0.10.0

Mireo SpaceTime MSQL connector

Mireo SpaceTime MSQL connector

msql-driver is a Python module for querying a Mireo SpaceTime database using the MSQL query language.

Features

• Both blocking and asynchronous modes of operation.
• Query results are convertible to Python lists, NumPy arrays, and Pandas dataframes.
• Streamlit integration with support for asynchronous querying.
• 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), Windows (x86-64 and arm64), and macOS (10.12+ x86-64 and 11.0+ arm64).

Installation

pip install -U msql-driver

Conversions to NumPy or Pandas data types require optional dependencies:

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

Install optional dependencies for all available conversions:

pip install -U msql-driver[convert]

Streamlit integration requires an optional dependency:

pip install -U msql-driver[streamlit]

Install all optional dependencies using:

pip install -U msql-driver[all]

Example

import msql_driver

# Connect
session = msql_driver.SessionConfig().host(<address>).user(<org>, <user>, <password>).build()
print(session.status())  # SessionStatus.Connected

# Run a query (returns one Rows object per result set)
res, = session.run_query("select * from st.segment limit 10")

# 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)

# Cancellable query execution
result, cancel = session.submit_query("select * from st.segment")
# ... cancel.cancel() to abort
res_list = result.try_get()  # non-blocking, returns None if not ready
res_list = result.get()      # blocks until ready

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

License

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

Credits

Authored and maintained by Mireo.