g2-sdk-go-base

command module
v0.6.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 29, 2024 License: Apache-2.0 Imports: 22 Imported by: 0

README

g2-sdk-go-base

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: g2-sdk-go-base 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 g2-sdk-go-base packages provide a Go language Software Development Kit that wraps the Senzing C SDK APIs.

Go Reference Go Report Card License

gosec.yaml go-test-linux.yaml go-test-darwin.yaml go-test-windows.yaml

Overview

The Senzing g2-sdk-go-base packages enable Go programs to call Senzing library functions. Under the covers, Golang's CGO is used by the g2-sdk-go-base packages to make calls to the functions in the Senzing C libraries. The g2-sdk-go-base implementation of the g2-sdk-go interface is used to call the Senzing C SDK APIs directly using Go's CGO.

Other implementations of the g2-sdk-go interface include:

Use

(TODO:)

References

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

Documentation

Overview

Synopsis

The Senzing g2-sdk-go-base packages are wrappers over Senzing's C-based library.

Overview

The Senzing g2-sdk-go-base packages enable Go programs to call Senzing library functions. Under the covers, Golang's CGO is used by the g2-sdk-go-base packages to make the calls to the Senzing functions.

More information at https://github.com/senzing-garage/g2-sdk-go-base

Installing Senzing library

Since the Senzing library is a pre-requisite, it must be installed first. This can be done by installing the Senzing package using apt, yum, or a technique using Docker containers. Once complete, the Senzing library will be installed in the /opt/senzing directory.

Using apt:

wget https://senzing-production-apt.s3.amazonaws.com/senzingrepo_1.0.0-1_amd64.deb
sudo apt install ./senzingrepo_1.0.0-1_amd64.deb
sudo apt update
sudo apt install senzingapi

Using yum:

sudo yum install https://senzing-production-yum.s3.amazonaws.com/senzingrepo-1.0.0-1.x86_64.rpm
sudo yum install senzingapi

Using Docker, build an installer:

curl -X GET \
    --output /tmp/senzing-versions-latest.sh \
    https://raw.githubusercontent.com/senzing-garage/knowledge-base/main/lists/senzing-versions-latest.sh
source /tmp/senzing-versions-latest.sh

sudo docker build \
    --build-arg SENZING_ACCEPT_EULA=I_ACCEPT_THE_SENZING_EULA \
    --build-arg SENZING_APT_INSTALL_PACKAGE=senzingapi=${SENZING_VERSION_SENZINGAPI_BUILD} \
    --build-arg SENZING_DATA_VERSION=${SENZING_VERSION_SENZINGDATA} \
    --no-cache \
    --tag senzing/installer:${SENZING_VERSION_SENZINGAPI} \
    https://github.com/senzing-garage/docker-installer.git#main

Using Docker, install Senzing:

sudo rm -rf /opt/senzing
sudo mkdir -p /opt/senzing

sudo docker run \
    --rm \
    --user 0 \
    --volume /opt/senzing:/opt/senzing \
    senzing/installer:${SENZING_VERSION_SENZINGAPI}

Examples

Examples of use can be seen in the xxxx_test.go files.

Directories

Path Synopsis
The g2config package is used to modify the in-memory representation of a Senzing configuration.
The g2config package is used to modify the in-memory representation of a Senzing configuration.
The g2configmgr package is used to modify Senzing configurations in the Senzing database.
The g2configmgr package is used to modify Senzing configurations in the Senzing database.
The g2diagnostic package is used to inspect the Senzing environment.
The g2diagnostic package is used to inspect the Senzing environment.
The g2engine package is used to add, modify, delete, and query records/entities in the Senzing engine.
The g2engine package is used to add, modify, delete, and query records/entities in the Senzing engine.
The g2product package is used to inspect the Senzing product.
The g2product package is used to inspect the Senzing product.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL