Starburst Scheduler
A Python CLI tool to run and schedule SQL queries on Starburst Galaxy or Starburst Enterprise clusters.
Installation
pip install starburst-scheduler
Requirements
- Starburst Galaxy or Enterprise cluster (e.g.,
free-cluster.trino.galaxy.starburst.io) - Valid Starburst username and password
- Python 3.9 or above
Usage
Run a One-Time Query
starburst-scheduler run-query \
--host free-cluster.trino.galaxy.starburst.io \
--user your-user@domain.com \
--password your-password \
--catalog tpch \
--schema tiny \
--query "SELECT 1"
Use Environment Variable (Secure)
# macOS/Linux
export STARBURST_PASSWORD=your-password
# Windows
set STARBURST_PASSWORD=your-password
starburst-scheduler run-query \
--host free-cluster.trino.galaxy.starburst.io \
--user your-user@domain.com \
--catalog tpch \
--schema tiny \
--query "SELECT 1"
Note: Default
--http-schemeishttps. Use--http-scheme httponly for local insecure clusters.
Schedule a Repeating Query
starburst-scheduler schedule-query \
--host free-cluster.trino.galaxy.starburst.io \
--user your-user@domain.com \
--password your-password \
--catalog tpch \
--schema tiny \
--query "SELECT * FROM nation" \
--frequency 60 \
--time-unit seconds
This runs the query every 60 seconds until manually stopped (Ctrl + C).
CLI Options
| Option | Description |
|---|---|
--host |
Starburst cluster host |
--user |
Starburst username or email |
--password |
Starburst password (or use env var) |
--catalog |
Catalog to query |
--schema |
Schema to query |
--query |
SQL query string |
--http-scheme |
https (default) or http for local use |
--frequency |
Frequency for scheduled query |
--time-unit |
Time unit (seconds, minutes, hours) |
Troubleshooting
Common Issues
-
Cluster Inactive Start it at: https://galaxy.starburst.io/home
-
401 Unauthorized
- Wrong credentials
- Quotes in environment variable
- Cluster not started
-
Connection Errors
- Wrong
--hostor--http-scheme
- Wrong
-
Access Denied
- User lacks permission on catalog/schema
-
Broken Installation
pip install --force-reinstall starburst-scheduler
License
MIT License
Contributing
Contributions are welcome. Submit issues or pull requests at: https://github.com/karranikhilreddy99/starburst_scheduler
Let me know if you want this delivered as a downloadable .md or .docx file.
Metadata
Release files for starburst-scheduler 0.1.10
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| starburst_scheduler-0.1.10.tar.gz | 5.7 kB | Without provenance | Details for starburst_scheduler-0.1.10.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| starburst_scheduler-0.1.10-py3-none-any.whl | Python 3 | none | any | Details for starburst_scheduler-0.1.10-py3-none-any.whl |
Total release size: 12.6 kB
Release files / starburst_scheduler-0.1.10.tar.gz
| Download URL | starburst_scheduler-0.1.10.tar.gz |
|---|---|
| Size | 5.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ee8aa585cd2ebef0b4f3c7f1502245efa37151c22387085abd68eb3b21a82c46
|
|
BLAKE2b-256 checksum How to use checksums |
3ef18b196126c9628f140f56f1390be68243f844bee90bf4d3e98263841cb9a4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.0
|
Release files / starburst_scheduler-0.1.10-py3-none-any.whl
| Download URL | starburst_scheduler-0.1.10-py3-none-any.whl |
|---|---|
| Size | 6.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0d9075ebe21fface6b3bfa45a2eeec91b087aa1171b3153f8c028acfc2ffa240
|
|
BLAKE2b-256 checksum How to use checksums |
052046deb4a1ee1d3f83032959fef4109fe910a015dd47b41fe8cd001b77d94c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.0
|
Security for starburst-scheduler 0.1.10
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.