sz-sdk-go

If you are beginning your journey with Senzing, please start with Senzing Quick Start guides.

You are in the Senzing Garage where projects are "tinkered" on. Although this GitHub repository may help you understand an approach to using Senzing, it's not considered to be "production ready" and is not considered to be part of the Senzing product. Heck, it may not even be appropriate for your application of Senzing!

⚠️ WARNING: sz-sdk-go is still in development ⚠️ _

At the moment, this is "work-in-progress" with Semantic Versions of 0.n.x. Although it can be reviewed and commented on, the recommendation is not to use it yet.

Synopsis

The Senzing sz-sdk-go packages provide interface definitions for implementations of the Senzing Go Software Development Kit. sz-sdk-go contains no "running code", but serves to unify implementations of the Senzing Go SDK.

Overview

When programming, the recommendation is to "program to an interface". The Senzing Go SDK API interfaces are documented at:

• Szconfig
• Szconfigmanager
• Szdiagnostic
• Szengine
• Szproduct

The Senzing sz-sdk-go packages provide interface definitions for the following implementations. For hints on usage, review the top-most main.go and the XXX_test.go files in package directories.

• Senzing/sz-sdk-go-core - an SDK for calling the Senzing C library locally.
• Senzing/sz-sdk-go-grpc - an SDK for calling the Senzing C library via gRPC network requests.
• Senzing/sz-sdk-go-mock - mock objects for developing and testing without the Senzing C library.
• Senzing/go-sdk-abstract-factory - An abstract factory pattern for switching among implementations.

Documentation and examples for the implementations are at:

• sz-sdk-go-core
• sz-sdk-go-grpc
• sz-sdk-go-mock
• go-sdk-abstract-factory

References

1. Development
2. Errors
3. Examples
4. Package reference