{"id":20258513,"url":"https://github.com/place-labs/flux","last_synced_at":"2025-09-02T03:38:18.841Z","repository":{"id":46715393,"uuid":"227301219","full_name":"place-labs/flux","owner":"place-labs","description":"InfluxDB v2.x crystal-lang client / Flux query language tools","archived":false,"fork":false,"pushed_at":"2025-03-25T03:54:21.000Z","size":129,"stargazers_count":6,"open_issues_count":3,"forks_count":2,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-11T01:02:21.685Z","etag":null,"topics":["client","crystal-lang","influxdb"],"latest_commit_sha":null,"homepage":"","language":"Crystal","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/place-labs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-12-11T07:17:45.000Z","updated_at":"2025-03-25T03:49:48.000Z","dependencies_parsed_at":"2025-04-11T01:02:23.420Z","dependency_job_id":"c98a43a0-8e4f-4d88-be9c-220dab715a88","html_url":"https://github.com/place-labs/flux","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/place-labs/flux","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/place-labs%2Fflux","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/place-labs%2Fflux/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/place-labs%2Fflux/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/place-labs%2Fflux/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/place-labs","download_url":"https://codeload.github.com/place-labs/flux/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/place-labs%2Fflux/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263742027,"owners_count":23504367,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["client","crystal-lang","influxdb"],"created_at":"2024-11-14T11:09:24.964Z","updated_at":"2025-07-05T12:32:54.731Z","avatar_url":"https://github.com/place-labs.png","language":"Crystal","funding_links":[],"categories":[],"sub_categories":[],"readme":"# flux\n\nClient library for pushing data to, and querying information from InfluxDB v2.x.\n\n## Installation\n\n1. Add the dependency to your `shard.yml`:\n\n```yaml\ndependencies:\n  flux:\n    github: place-labs/flux\n```\n\n2. Run `shards install`\n\n## Usage\n\n```crystal\nrequire \"flux\"\n```\n\n### Configure the client\n\nDefine your client configuration with `Flux.configure`. This yields an\n[`Options`](https://github.com/place-labs/flux/blob/master/src/flux.cr#L7-L15) object\nwith appriopriate setters.\n\n```crystal\nFlux.configure do |settings|\n  settings.uri     = ENV[\"INFLUX_HOST\"]? || abort \"INFLUX_HOST env var not set\"\n  settings.api_key = ENV[\"INFLUX_API_KEY\"]? || abort \"INFLUX_API_KEY env var not set\"\n  settings.org     = ENV[\"INFLUX_ORG\"]? || \"vandelay-industries\"\n  settings.bucket  = ENV[\"INFLUX_BUCKET\"]? || \"latex-sales\"\nend\n```\n\n**NOTE**: `INFLUX_HOST` is expected to be a well-formed URI.\n\n### Writing data\n\nUse `Flux.write` to enqueue a point. Writes are automatically buffered and\nflushed after either a time delay or optimal write size.\n\n### Running queries\n\nOnce information is available in the bucket, queries are executed with\n`Flux.query`.  This accepts a [Flux\nexpression](https://v2.docs.influxdata.com/v2.0/reference/flux/).\n\n### Parallel clients\n\nIf your application requires connectivity with more that one InfluxDB instance\nor bucket, clients can be directly created with `Flux::Client.new`.\n\n## Contributing\n\n1. Fork it (\u003chttps://github.com/place-labs/flux/fork\u003e)\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n## Contributors\n\n- [Kim Burgess](https://github.com/kimburgess) - creator and maintainer\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplace-labs%2Fflux","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplace-labs%2Fflux","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplace-labs%2Fflux/lists"}