msql-driver 0.9.0

Mireo SpaceTime MSQL connector

Mireo SpaceTime MSQL connector

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

Features

• Both blocking and asynchronous modes of operation are available.
• Query results are convertible to Python lists, NumPy arrays and Pandas dataframes.
• Streamlit integration with support for asynchronous querying available.
• 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 available with 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 query
res, = session.run_query("select * from st.segment limit 10")

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

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

# Query result can be converted to:
rows = res.to_list()  # Python list of appropriate Python data types
arr = res.to_numpy()  # NumPy array of appropriate NumPy data types (requires numpy)
df = res.to_pandas()  # Pandas dataframe of appropriate NumPy/Pandas data types (requires pandas)

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

License

Licensed under BSD 3-Clause “New” or “Revised” License.

Credits

Authored and maintained by Mireo.