senzing/senzing-tools repository overview

⁠senzing-tools

⁠:warning: WARNING: senzing-tools is still in development :warning: _

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

senzing-tools is a suite of tools to help use the Senzing API.

⁠Overview

Senzing's senzing-tools has the following tools/commands:

1. init-database⁠ - Used to create a Senzing schema and configuration in PostgreSQL, MySQL, MsSQL and SQLite databases.
2. observer⁠ - Aggregates Observer messages
3. serve-grpc⁠ - A gRPC server of the Senzing API
4. serve-http⁠ - An HTTP server for Senzing Tools

⁠Install

1. Visit Releases⁠ page.

2. For the desired versioned release, in the "Assets" section, download the appropriate installation package.

   1. Use .deb file for Debian, Ubuntu and others⁠
   2. Use .rpm file for Red Hat, CentOS, openSuse and others⁠.

3. :pencil2: Example installation for .deb file:

   sudo apt install ./senzing-tools-0.0.0.deb
   

   Copy

4. :pencil2: Example installation for .rpm file:

   sudo yum install ./senzing-tools-0.0.0.rpm
   

   Copy

⁠Use

1. Important: Prior to using the senzing-tools command, the LD_LIBRARY_PATH environment variable must be set to the location of the Senzing binaries. Example:

   export LD_LIBRARY_PATH=/opt/senzing/g2/lib/
   

   Copy

⁠Using command line options

Simple examples.

1. :pencil2: A senzing-tools init-database example:

   export LD_LIBRARY_PATH=/opt/senzing/g2/lib/
   senzing-tools init-database \
       --database-url postgresql://username:[email protected]:5432/G2
   

   Copy

Each command has it's own list of supported command line options. Documentation for the command line options:

1. Online documentation, see hub.senzing.com/senzing-tools⁠

2. Runtime documentation, run:

   export LD_LIBRARY_PATH=/opt/senzing/g2/lib/
   senzing-tools [command] --help
   

   Copy

3. Detailed documentation, visit:

   1. init-database⁠
   2. serve-grpc⁠

⁠Using environment variables

Environment variables may be used instead of command-line options. Each command has it's own list of supported environment variables. So see a specific list, visit the appropriate command.

1. Commands:
   1. init-database⁠
   2. serve-grpc⁠

⁠Using Docker

The senzing-tools can be run from the senzing/senzing-tools Docker container. Each command has it's own list of supported environment variables and command line options. So see a specific list, visit the appropriate command.

1. Commands:
   1. init-database⁠
   2. serve-grpc⁠

This usage shows how to initialze a database with a Docker container.

1. :pencil2: A senzing/senzing-tools init-databaseexample:

   docker run \
       --env SENZING_TOOLS_DATABASE_URL=postgresql://username:[email protected]:5432/G2 \
       senzing/senzing-tools init-database
   

   Copy

2. Alternative: Using SENZING_TOOLS_ENGINE_CONFIGURATION_JSON environment variable.

   1. :pencil2: Set SENZING_TOOLS_ENGINE_CONFIGURATION_JSON. Example:

      export SENZING_TOOLS_ENGINE_CONFIGURATION_JSON='{
          "PIPELINE": {
              "CONFIGPATH": "/etc/opt/senzing",
              "RESOURCEPATH": "/opt/senzing/g2/resources",
              "SUPPORTPATH": "/opt/senzing/data"
          },
          "SQL": {
              "CONNECTION": "postgresql://username:[email protected]:5432:G2"
          }
      }'
      

      Copy

   2. Run senzing/senzing-tools. Note: SENZING_TOOLS_ENGINE_CONFIGURATION_JSON superceeds use of SENZING_TOOLS_DATABASE_URL. Example:

      docker run \
          --env SENZING_TOOLS_ENGINE_CONFIGURATION_JSON \
          senzing/senzing-tools init-database
      

      Copy

⁠Parameters

See individual commands for parameters:

1. init-database⁠
2. serve-grpc⁠

⁠References

• Command reference⁠
• Development⁠
• Errors⁠
• Examples⁠