-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
149 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,145 @@ | ||
| # demo-quickstart | ||
| # demo-quickstart | ||
|
|
||
| If you are beginning your journey with | ||
| [Senzing](https://senzing.com/), | ||
| please start with | ||
| [Senzing Quick Start guides](https://docs.senzing.com/quickstart/). | ||
|
|
||
| You are in the | ||
| [Senzing Garage](https://github.com/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: WARNING: demo-quickstart 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 | ||
|
|
||
| `demo-quickstart` is a command in the | ||
| [senzing-tools](https://github.com/senzing-garage/senzing-tools) | ||
| suite of tools. | ||
| This command creates an environment for exploring Senzing. | ||
|
|
||
| [](https://pkg.go.dev/github.com/senzing-garage/demo-quickstart) | ||
| [](https://goreportcard.com/report/github.com/senzing-garage/demo-quickstart) | ||
| [](https://github.com/senzing-garage/demo-quickstart/blob/main/LICENSE) | ||
|
|
||
| [](https://github.com/senzing-garage/demo-quickstart/actions/workflows/gosec.yaml) | ||
| [](https://github.com/senzing-garage/demo-quickstart/actions/workflows/go-test-linux.yaml) | ||
| [](https://github.com/senzing-garage/demo-quickstart/actions/workflows/go-test-darwin.yaml) | ||
| [](https://github.com/senzing-garage/demo-quickstart/actions/workflows/go-test-windows.yaml) | ||
|
|
||
| ## 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](https://github.com/senzing/g2-sdk-go-grpc) | ||
| 1. Python: [g2-sdk-python-grpc](https://github.com/senzing-garage/g2-sdk-python-grpc) | ||
|
|
||
| A simple demonstration using `senzing-tools` and a SQLite database. | ||
|
|
||
| ```console | ||
| 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](http://localhost:8261) | ||
|
|
||
| ## Install | ||
|
|
||
| 1. The `demo-quickstart` command is installed with the | ||
| [senzing-tools](https://github.com/senzing-garage/senzing-tools) | ||
| suite of tools. | ||
| See senzing-tools [install](https://github.com/senzing-garage/senzing-tools#install). | ||
|
|
||
| ## Use | ||
|
|
||
| ```console | ||
| export LD_LIBRARY_PATH=/opt/senzing/g2/lib/ | ||
| senzing-tools demo-quickstart [flags] | ||
| ``` | ||
|
|
||
| 1. For options and flags: | ||
| 1. [Online documentation](https://hub.senzing.com/senzing-tools/senzing-tools_demo-quickstart.html) | ||
| 1. Runtime documentation: | ||
|
|
||
| ```console | ||
| export LD_LIBRARY_PATH=/opt/senzing/g2/lib/ | ||
| senzing-tools demo-quickstart --help | ||
| ``` | ||
|
|
||
| 1. In addition to the following simple usage examples, there are additional [Examples](docs/examples.md). | ||
|
|
||
| ### Using command line options | ||
|
|
||
| 1. :pencil2: Specify database using command line option. | ||
| Example: | ||
|
|
||
| ```console | ||
| export LD_LIBRARY_PATH=/opt/senzing/g2/lib/ | ||
| senzing-tools demo-quickstart \ | ||
| --database-url postgresql://username:password@postgres.example.com:5432/G2 \ | ||
|
|
||
| ``` | ||
|
|
||
| 1. Visit [localhost:8261](http://localhost:8261) | ||
| 1. Run `senzing-tools demo-quickstart --help` or see [Parameters](#parameters) for additional parameters. | ||
|
|
||
| ### Using environment variables | ||
|
|
||
| 1. :pencil2: Specify database using environment variable. | ||
| Example: | ||
|
|
||
| ```console | ||
| 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 | ||
| ``` | ||
|
|
||
| 1. Visit [localhost:8261](http://localhost:8261) | ||
| 1. Run `senzing-tools demo-quickstart --help` or see [Parameters](#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: | ||
|
|
||
| ```console | ||
| docker run \ | ||
| --publish 8260:8260 \ | ||
| --publish 8261:8261 \ | ||
| --rm \ | ||
| senzing/senzing-tools demo-quickstart | ||
|
|
||
| ``` | ||
|
|
||
| 1. Visit [localhost:8261](http://localhost:8261) | ||
| 1. See [Parameters](#parameters) for additional parameters. | ||
|
|
||
| ### Parameters | ||
|
|
||
| - **[SENZING_TOOLS_DATABASE_URL](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_database_url)** | ||
| - **[SENZING_TOOLS_ENGINE_CONFIGURATION_JSON](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_engine_configuration_json)** | ||
| - **[SENZING_TOOLS_ENGINE_LOG_LEVEL](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_engine_log_level)** | ||
| - **[SENZING_TOOLS_ENGINE_MODULE_NAME](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_engine_module_name)** | ||
| - **[SENZING_TOOLS_GRPC_PORT](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_grpc_port)** | ||
| - **[SENZING_TOOLS_LOG_LEVEL](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_log_level)** | ||
|
|
||
| ## References | ||
|
|
||
| 1. [Command reference](https://hub.senzing.com/senzing-tools/senzing-tools_demo-quickstart.html) | ||
| 1. [Development](docs/development.md) | ||
| 1. [Errors](docs/errors.md) | ||
| 1. [Examples](docs/examples.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters