https://github.com/swetrix/cq-source-swetrix
Swetrix CloudQuery integration
https://github.com/swetrix/cq-source-swetrix
Last synced: 10 months ago
JSON representation
Swetrix CloudQuery integration
- Host: GitHub
- URL: https://github.com/swetrix/cq-source-swetrix
- Owner: Swetrix
- License: mit
- Created: 2023-01-27T22:54:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-20T19:44:43.000Z (over 2 years ago)
- Last Synced: 2024-06-20T06:27:24.512Z (almost 2 years ago)
- Language: Go
- Size: 50.8 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CloudQuery Swetrix Source Plugin
A Swetrix source plugin for CloudQuery that loads data from Swetrix to any database, data warehouse or data lake supported by [CloudQuery](https://www.cloudquery.io/), such as PostgreSQL, BigQuery, Athena, and many more.
## Links
- [CloudQuery Quickstart Guide](https://www.cloudquery.io/docs/quickstart)
- [Configuration](docs/overview.md)
- [Supported Tables](docs/tables/README.md)
## Authentication
The Swetrix source plugin uses the [Swetrix API](https://docs.swetrix.com/statistics-api) to fetch data. You will need to create an API key in the Swetrix portal. See the [Configuration](docs/overview.md) section for more information on running the Swetrix plugin.
## Development
### Run tests
```bash
make test
```
### Run linter
```bash
make lint
```
### Generate docs
```bash
make gen-docs
```
### Compile
```bash
make build
```
### Release a new version
1. Run `git tag v1.0.0` to create a new tag for the release (replace `v1.0.0` with the new version number)
2. Run `git push origin v1.0.0` to push the tag to GitHub
Once the tag is pushed, a new GitHub Actions workflow will be triggered to build the release binaries and create the new release on GitHub.
To customize the release notes, see the Go releaser [changelog configuration docs](https://goreleaser.com/customization/changelog/#changelog).
### Publish a new version to the Cloudquery Hub
After tagging a release, you can build and publish a new version to the [Cloudquery Hub](https://hub.cloudquery.io/) by running the following commands.
Replace `v1.0.0` with the new version number.
```bash
# "make dist" uses the README as main documentation and adds a generic release note. Output is created in dist/
VERSION=v1.0.0 make dist
# Login to cloudquery hub and publish the new version
cloudquery login
cloudquery plugin publish --finalize
```
After publishing the new version, it will show up in the [hub](https://hub.cloudquery.io/).
For more information please refer to the official [Publishing a Plugin to the Hub](https://www.cloudquery.io/docs/developers/publishing-a-plugin-to-the-hub) guide.