InfluxDB Connector for GoFr #2072
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| # InfluxDB | ||
| GoFr supports injecting InfluxDB using an interface that defines the necessary methods to interact with InfluxDB v2+. | ||
| Any driver that implements this interface can be injected via the `app.AddInfluxDB()` method. | ||
|
|
||
| --- | ||
|
|
||
| ## Interface | ||
|
|
||
| ```go | ||
| // InfluxDB defines the methods for interacting with an InfluxDB database. | ||
| type InfluxDB interface { | ||
| Connect() | ||
| CreateOrganization(ctx context.Context, orgName string) (string, error) | ||
| DeleteOrganization(ctx context.Context, orgID string) error | ||
| ListOrganization(ctx context.Context) (map[string]string, error) | ||
|
|
||
| CreateBucket(ctx context.Context, orgID string, bucketName string, retentionPeriod time.Duration) (string, error) | ||
| DeleteBucket(ctx context.Context, orgID, bucketID string) error | ||
| ListBuckets(ctx context.Context, org string) (map[string]string, error) | ||
|
|
||
| Ping(ctx context.Context) (bool, error) | ||
| HealthCheck(ctx context.Context) (any, error) | ||
|
|
||
| Query(ctx context.Context, org string, fluxQuery string) ([]map[string]any, error) | ||
| WritePoints(ctx context.Context, bucket string, org string, points []container.InfluxPoint) error) | ||
|
|
||
| UseLogger(logger any) | ||
| UseMetrics(metrics any) | ||
| UseTracer(tracer any) | ||
|
Comment on lines
+27
to
+29
There was a problem hiding this comment. This is not exposed to user. Refer to mongoDB datasource addition for more info. |
||
| } | ||
| ``` | ||
|
|
||
| This structure supports all essential InfluxDB operations including organization/bucket management, health checks, and metrics ingestion. | ||
|
|
||
| Import the gofr's external driver for influxdb: | ||
|
|
||
| ```bash | ||
| go get gofr.dev/pkg/gofr/datasource/influxdb@latest | ||
| ``` | ||
|
|
||
| ## Example | ||
| ```go | ||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "gofr.dev/pkg/gofr" | ||
| "gofr.dev/pkg/gofr/datasource/influxdb" | ||
| ) | ||
|
|
||
| func main() { | ||
|
|
||
| // Create a new GoFr application | ||
| app := gofr.New() | ||
|
|
||
| // Initialize InfluxDB client | ||
| client := influxdb.New(influxdb.Config{ | ||
| Url: "http://localhost:8086", | ||
| Username: "admin", | ||
| Password: "admin1234", | ||
| Token: "<your-token>", | ||
| }) | ||
|
|
||
| // Add InfluxDB to application context | ||
| app.AddInfluxDB(client) | ||
|
|
||
| // Sample route | ||
| app.GET("/greet", func(ctx *gofr.Context) (any, error) { | ||
| return "Hello World!", nil | ||
| }) | ||
|
|
||
| // Ping InfluxDB | ||
| ok, err := client.Ping(context.Background()) | ||
| if err != nil { | ||
| fmt.Println("Ping failed:", err) | ||
| return | ||
| } | ||
| fmt.Println("InfluxDB connected:", ok) | ||
|
|
||
|
|
||
| // Create organization | ||
| orgID, err := client.CreateOrganization(context.Background(), "demo-org") | ||
| if err != nil { | ||
| fmt.Println("CreateOrganization error:", err) | ||
| return | ||
| } | ||
|
|
||
| // List organizations | ||
| orgs, _ := client.ListOrganization(context.Background()) | ||
| fmt.Println("Organizations:") | ||
| for id, name := range orgs { | ||
| fmt.Printf("- %s: %s\n", id, name) | ||
| } | ||
|
|
||
| // Create bucket | ||
| bucketID, err := client.CreateBucket(context.Background(), orgID, "demo-bucket", time.Hour) | ||
| if err != nil { | ||
| fmt.Println("CreateBucket error:", err) | ||
| return | ||
| } | ||
|
|
||
| // List buckets for organization | ||
| buckets, err := client.ListBuckets(context.Background(), "demo-org") | ||
| if err != nil { | ||
| fmt.Println("ListBuckets error:", err) | ||
| return | ||
| } | ||
| fmt.Println("Buckets:", buckets) | ||
|
|
||
| // Delete bucket | ||
| if err := client.DeleteBucket(context.Background(), orgID, bucketID); err != nil { | ||
| fmt.Println("DeleteBucket error:", err) | ||
| return | ||
| } | ||
| fmt.Println("Bucket deleted successfully") | ||
|
|
||
| // Delete organization | ||
| if err := client.DeleteOrganization(context.Background(), orgID); err != nil { | ||
| fmt.Println("DeleteOrganization error:", err) | ||
| return | ||
| } | ||
| fmt.Println("Organization deleted successfully") | ||
|
|
||
|
There was a problem hiding this comment. Write a setup function .... pseudo and then make REST endpoints for adding, retrieving data. |
||
| // Start the server | ||
| app.Run() | ||
| } | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.