https://github.com/catkins/qbt
Query Google Cloud Bigtable using Lua snippets
https://github.com/catkins/qbt
bigtable cobra gcp go golang google-cloud-platform gopher-lua lua
Last synced: 16 days ago
JSON representation
Query Google Cloud Bigtable using Lua snippets
- Host: GitHub
- URL: https://github.com/catkins/qbt
- Owner: catkins
- License: mit
- Created: 2018-04-15T12:21:55.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-07-03T04:32:47.000Z (almost 7 years ago)
- Last Synced: 2024-10-19T21:46:33.844Z (6 months ago)
- Topics: bigtable, cobra, gcp, go, golang, google-cloud-platform, gopher-lua, lua
- Language: Go
- Size: 3.41 MB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
QBT - Query BigTable
--------------------
QBT is a small CLI application for querying Google Cloud BigTable, using the Lua programming language to express queries.
### Why
[`cbt`](https://cloud.google.com/bigtable/docs/go/cbt-overview) is a great tool for managing BigTable tables and column familes, but it's `read` subcomand is somewhat limited in that it doesn't allow you to provide any filters or transformations to your data.
The other option for ad-hoc queries into BigTable is to write custom scripts in your language of choice, which is quite time-consuming for exploratory queries.
### Installation
#### Requirements
- Go 1.9+
- gcloud CLI
```
go get -u github.com/catkins/qbt
gcloud auth applicatiom-default login
```
### Usage
```
qbt [--project=] [--instance=] [--prefix=] query
```
### Example
```sh
qbt query my_table 'return row.my_cf["my_cf:haystack"] == "needle"'
# json decoding also included
qbt query my_table '
json = require("json")
decoded_value = json.decode(row.my_cf["my_cf:haystack"])
return decoded_value["nested_field"] == 123
'
```
### Configuration
Configuration can also be provided from the environment by providing the `QBT_PROJECT`, `QBT_INSTANCE`, and `QBT_PREFIX` environment variables, or via CLI flags.
### Libraries used
- GCP client libraries for Go: cloud.google.com/go
- Cobra for CLI: github.com/spf13/cobra
- Viper for configuration: github.com/spf13/viper
- Lua implementation gopher-lua: github.com/yuin/gopher-lua
- JSON support for gopher-lua: layeh.com/gopher-json
- Errors: github.com/pkg/errors
### Todo / Ideas
- [ ] Tests!
- [ ] Add result transformations
- [ ] Add other output types (eg. YAML, CSV, strings returned from scripts)
- [ ] Add debug logging
- [ ] Queries from file / STDIN
- [ ] Pre-query scripts (eg. to define functions)
- [x] Add CLI params for specifying range / prefix queries
- [ ] Web server for submitting queries to
- [ ] Other authentication methods
### Licence
Copyright 2018 Chris Atkins
MIT