# Go SDK ## Requirements Go 1.22 or higher ## Installation To install the SDK, run the following command: ```bash go get github.com/genesisdb-io/genesisdb-io-client-go ``` ## Configuration The SDK requires the following environment variables to be set: ```bash GENESISDB_API_URL=http://localhost:8080 GENESISDB_AUTH_TOKEN= GENESISDB_API_VERSION=v1 ``` ## Usage To use the SDK, you need to create a client and connect to the Genesis DB instance. The client will handle the connection and the authentication. ## Instantiate the client ```go import ( "github.com/genesisdb-io/genesisdb-io-client-go" ) config := &genesisdb.Config{ APIURL: "https://your-api-url", APIVersion: "v1", AuthToken: "your-auth-token", } client, err := genesisdb.NewClient(config) if err != nil { log.Fatal(err) } ``` ## Stream Events ```go events, err := client.StreamEvents("/customer") if err != nil { log.Fatal(err) } for _, event := range events { fmt.Printf("Event Type: %s, Data: %v\n", event.Type, event.Data) } ``` ## Stream Events from lower bound ```go options := &genesisdb.StreamOptions{ LowerBound: "2d6d4141-6107-4fb2-905f-445730f4f2a9", IncludeLowerBoundEvent: true, } events, err := client.StreamEvents("/", options) if err != nil { log.Fatal(err) } for _, event := range events { fmt.Printf("Event Type: %s, Data: %v\n", event.Type, event.Data) } ``` ## Stream Events with upper bound ```go options := &genesisdb.StreamOptions{ UpperBound: "9f3e4141-7208-4fb2-905f-445730f4f3b1", IncludeUpperBoundEvent: false, } events, err := client.StreamEvents("/", options) if err != nil { log.Fatal(err) } for _, event := range events { fmt.Printf("Event Type: %s, Data: %v\n", event.Type, event.Data) } ``` ## Stream Events with both lower and upper bounds ```go options := &genesisdb.StreamOptions{ LowerBound: "2d6d4141-6107-4fb2-905f-445730f4f2a9", IncludeLowerBoundEvent: true, UpperBound: "9f3e4141-7208-4fb2-905f-445730f4f3b1", IncludeUpperBoundEvent: false, } events, err := client.StreamEvents("/", options) if err != nil { log.Fatal(err) } for _, event := range events { fmt.Printf("Event Type: %s, Data: %v\n", event.Type, event.Data) } ``` ## Stream Latest Events by Event Type ```go options := &genesisdb.StreamOptions{ LatestByEventType: "io.genesisdb.app.customer-added", } events, err := client.StreamEvents("/", options) if err != nil { log.Fatal(err) } for _, event := range events { fmt.Printf("Event Type: %s, Data: %v\n", event.Type, event.Data) } // This feature allows you to stream only the latest event of a specific type for each subject. // Useful for getting the current state of entities. ``` ## Commit Events ```go events := []genesisdb.Event{ { Source: "io.genesisdb.app", Subject: "/customer", Type: "io.genesisdb.app.customer-added", Data: map[string]interface{}{ "firstName": "Bruce", "lastName": "Wayne", "emailAddress": "bruce.wayne@enterprise.wayne" }, }, { Source: "io.genesisdb.app", Subject: "/customer", Type: "io.genesisdb.app.customer-added", Data: map[string]interface{}{ "firstName": "Alfred", "lastName": "Pennyworth", "emailAddress": "alfred.pennyworth@enterprise.wayne" }, }, { Source: "io.genesisdb.store", Subject: "/article", Type: "io.genesisdb.store.article-added", Data: map[string]interface{}{ "name": "Tumbler", "color": "black", "price": 2990000.00 }, }, { Source: "io.genesisdb.app", Subject: "/customer/fed2902d-0135-460d-8605-263a06308448", Type: "io.genesisdb.app.customer-personaldata-changed", Data: map[string]interface{}{ "firstName": "Angus", "lastName": "MacGyver", "emailAddress": "angus.macgyer@phoenix.foundation" }, }, } err := client.CommitEvents(events) if err != nil { log.Fatal(err) } ``` ## Commit events with preconditions ```go events := []genesisdb.Event{ { Source: "io.genesisdb.app", Subject: "/user/456", Type: "io.genesisdb.app.user-created", Data: map[string]interface{}{ "firstName": "John", "lastName": "Doe", "email": "john.doe@example.com", }, }, } preconditions := []genesisdb.Precondition{ { Type: "isSubjectNew", Payload: map[string]interface{}{ "subject": "/user/456", }, }, } err := client.CommitEventsWithPreconditions(events, preconditions) if err != nil { log.Fatal(err) } ``` ```go events := []genesisdb.Event{ { Source: "io.genesisdb.app", Subject: "/event/conf-2024", Type: "io.genesisdb.app.registration-added", Data: map[string]interface{}{ "attendeeName": "Alice", "eventId": "conf-2024", }, }, } preconditions := []genesisdb.Precondition{ { Type: "isQueryResultTrue", Payload: map[string]interface{}{ "query": "STREAM e FROM events WHERE e.data.eventId == 'conf-2024' MAP COUNT() < 500", }, }, } err := client.CommitEventsWithPreconditions(events, preconditions) if err != nil { log.Fatal(err) } ``` ## Usage of referenced data (GDPR) ```go events := []genesisdb.Event{ { Source: "io.genesisdb.app", Subject: "/user/456", Type: "io.genesisdb.app.user-created", Data: map[string]interface{}{ "firstName": "John", "lastName": "Doe", "email": "john.doe@example.com", }, Options: map[string]interface{}{ "storeDataAsReference": true, }, }, } err := client.CommitEvents(events) if err != nil { log.Fatal(err) } ``` ## Deleting referenced data (GDPR) ```go err := client.EraseData("/user/456") if err != nil { log.Fatal(err) } ``` ## Observe Events ```go eventChan, errorChan := client.ObserveEvents("/customer") go func() { for { select { case event := <-eventChan: fmt.Printf("Real-time event: Type=%s, Subject=%s, Data=%v\n", event.Type, event.Subject, event.Data) case err := <-errorChan: if err != nil { fmt.Printf("Observe error: %v\n", err) } return } } }() ``` ## Observe Events from lower bound (Message queue) ```go options := &genesisdb.StreamOptions{ LowerBound: "2d6d4141-6107-4fb2-905f-445730f4f2a9", IncludeLowerBoundEvent: true, } // Start observing events for a subject with lower bound eventChan, errorChan := client.ObserveEvents("/customer", options) // Listen for events in a goroutine go func() { for { select { case event := <-eventChan: fmt.Printf("Real-time event: Type=%s, Subject=%s, Data=%v\n", event.Type, event.Subject, event.Data) case err := <-errorChan: if err != nil { fmt.Printf("Observe error: %v\n", err) } return } } }() ``` ## Observe Events with upper bound (Message queue) ```go options := &genesisdb.StreamOptions{ UpperBound: "9f3e4141-7208-4fb2-905f-445730f4f3b1", IncludeUpperBoundEvent: false, } eventChan, errorChan := client.ObserveEvents("/customer", options) go func() { for { select { case event := <-eventChan: fmt.Printf("Real-time event: Type=%s, Subject=%s, Data=%v\n", event.Type, event.Subject, event.Data) case err := <-errorChan: if err != nil { fmt.Printf("Observe error: %v\n", err) } return } } }() ``` ## Observe Events with both bounds (Message queue) ```go options := &genesisdb.StreamOptions{ LowerBound: "2d6d4141-6107-4fb2-905f-445730f4f2a9", IncludeLowerBoundEvent: true, UpperBound: "9f3e4141-7208-4fb2-905f-445730f4f3b1", IncludeUpperBoundEvent: false, } eventChan, errorChan := client.ObserveEvents("/customer", options) go func() { for { select { case event := <-eventChan: fmt.Printf("Real-time event: Type=%s, Subject=%s, Data=%v\n", event.Type, event.Subject, event.Data) case err := <-errorChan: if err != nil { fmt.Printf("Observe error: %v\n", err) } return } } }() ``` ## Observe Latest Events by Event Type (Message queue) ```go options := &genesisdb.StreamOptions{ LatestByEventType: "io.genesisdb.app.customer-added", } eventChan, errorChan := client.ObserveEvents("/customer", options) go func() { for { select { case event := <-eventChan: fmt.Printf("Real-time event: Type=%s, Subject=%s, Data=%v\n", event.Type, event.Subject, event.Data) case err := <-errorChan: if err != nil { fmt.Printf("Observe error: %v\n", err) } return } } }() ``` ## Query Events ```go query := `STREAM e FROM events WHERE e.type == 'io.genesisdb.app.customer-added' ORDER BY e.time MAP { id: e.id, firstName: e.data.firstName, lastName: e.data.lastName }` results, err := client.QueryEvents(query) if err != nil { log.Fatal(err) } for _, result := range results { fmt.Printf("Result: %v\n", result) } ``` ## Health Checks ```go // Ping the API response, err := client.Ping() if err != nil { log.Fatal(err) } fmt.Printf("Ping response: %s\n", response) // Run audit response, err = client.Audit() if err != nil { log.Fatal(err) } fmt.Printf("Audit response: %s\n", response) ``` ## Error Handling All methods return errors when something goes wrong. Make sure to check for errors and handle them appropriately.

Navigation

Go SDK