demo-quickstart

README

demo-quickstart

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: demo-quickstart 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

demo-quickstart is a command in the senzing-tools suite of tools. This command creates an environment for exploring Senzing.

Overview

demo-quickstart starts the Senzing gRPC server and HTTP server for use in Senzing exploration.

Senzing SDKs for accessing the gRPC server:

1. Go: g2-sdk-go-grpc
2. Python: g2-sdk-python-grpc

A simple demonstration using senzing-tools and a SQLite database.

export LD_LIBRARY_PATH=/opt/senzing/g2/lib/
export SENZING_TOOLS_DATABASE_URL=sqlite3://na:na@/tmp/sqlite/G2C.db
senzing-tools init-database
senzing-tools demo-quickstart

Then visit localhost:8261

Install

1. The demo-quickstart command is installed with the senzing-tools suite of tools. See senzing-tools install.

Use

export LD_LIBRARY_PATH=/opt/senzing/g2/lib/
senzing-tools demo-quickstart [flags]

1. For options and flags:

   1. Online documentation

   2. Runtime documentation:

      export LD_LIBRARY_PATH=/opt/senzing/g2/lib/
      senzing-tools demo-quickstart --help
      

2. In addition to the following simple usage examples, there are additional Examples.

Using command line options

1. ✏ Specify database using command line option. Example:

   export LD_LIBRARY_PATH=/opt/senzing/g2/lib/
   senzing-tools demo-quickstart \
       --database-url postgresql://username:password@postgres.example.com:5432/G2 \
   
   

2. Visit localhost:8261

3. Run senzing-tools demo-quickstart --help or see Parameters for additional parameters.

Using environment variables

1. ✏ Specify database using environment variable. Example:

   export LD_LIBRARY_PATH=/opt/senzing/g2/lib/
   export SENZING_TOOLS_DATABASE_URL=postgresql://username:password@postgres.example.com:5432/G2
   senzing-tools demo-quickstart
   

2. Visit localhost:8261

3. Run senzing-tools demo-quickstart --help or see Parameters for additional parameters.

Using Docker

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

1. This usage specifies a URL of an external database. Example:

   docker run \
       --publish 8260:8260 \
       --publish 8261:8261 \
       --rm \
       senzing/senzing-tools demo-quickstart
   
   

2. Visit localhost:8261

3. See Parameters for additional parameters.

Parameters

• SENZING_TOOLS_DATABASE_URL
• SENZING_TOOLS_ENGINE_CONFIGURATION_JSON
• SENZING_TOOLS_ENGINE_LOG_LEVEL
• SENZING_TOOLS_ENGINE_MODULE_NAME
• SENZING_TOOLS_GRPC_PORT
• SENZING_TOOLS_LOG_LEVEL

References

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

Documentation

Overview

One or two sentence synopsys of the module. The Senzing XXXX module is...

Overview

One or two paragraph overview of this module...

(This page describes the nature of the entire Go module or the top-level command, not an individual package.)

More information at https://github.com/senzing-garage/demo-quickstart

Example Package

The example package gives an example layout for a package. This includes how documentation, tests, and examples should be done. This paragraph (or two) should provide a brief overview while linking the reader to the documentation included in the package itself.

More information can be found in the pkg/github.com/senzing-garage/demo-quickstart/examplepackage documentation.

Another Header: Package or other module features...

More details about the module... Lorem ipsum dolor sit amet, consectetur adipiscing elit...

Examples

The examples given here should show a holistic view of the module, if appropriate.

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

package main
import (
	fmt

	"github.com/senzing-garage/demo-quickstart/examplepackage"
	"github.com/senzing-garage/demo-quickstart/anotherpackage"
)

func main() {
	ctx := context.TODO()
	testObject := &ExamplePackageImpl{
		Something: "I'm here",
	}
	err := testObject.SaySomething(ctx)
	if err != nil {
		fmt.Println("whoops")
	}
	anotherpackage.DoSomething(ctx)...
}