Skip to content
Snippets Groups Projects
Commit 9ce43f13 authored by Maaz Ahmed's avatar Maaz Ahmed
Browse files

chore: update README

parent 221b1eef
No related branches found
No related tags found
No related merge requests found
# mquery (placeholder name)
A Rust library for handling PROMQL (and possibly MetricsQL) queries.
# Usage Example
```rust
use mquery::{Auth, QueryManager};
use tokio::runtime::Runtime;
dotenv::dotenv().expect("No .env file found in working dir");
let url = std::env::var("VM_URL").expect("VM URL not found in env");
let token = std::env::var("VM_TOKEN").expect("VM URL not found in env");
let rt = Runtime::new().unwrap();
let query = "total_http_requests";
let _response = rt
.block_on(
QueryManager::new(url.parse().unwrap())
.auth(Auth::Bearer(token))
.query(query),
)
.expect("operation failed");
}
```
# Roadmap
- [x] Basic raw queries (Instant and Ranged)
- [ ] Query Builder
- [ ] Basic queries
- [ ] Operators
- [ ] Functions
- [ ] Runtime syntax checking
- [ ] Compile time syntax checking
- [ ] Deserialize to custom data types
- [ ] Deserialize to custom data types (with the help of proc-macros?)
- [ ] Encapsulated raw queries with methods for constructing interpolated versions
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment