serve-grpc

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: serve-grpc 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

Overview

serve-grpc supports the Senzing Protocol Buffer definitions. Under the covers, the gRPC request is translated by the gRPC server into a Senzing Go SDK call using senzing/sz-sdk-go-core. The response from the Senzing Go SDK is returned to the gRPC client.

Senzing SDKs for accessing the gRPC server:

1. Python: sz-sdk-python-grpc
2. Java: sz-sdk-java-grpc
3. C-sharp sz-sdk-csharp-grpc
4. Go: sz-sdk-go-grpc

Install

Use

1. Docker container with internal, ephemeral database and gRPC accessible on port 8261. Example:

   docker run -it -p 8261:8261 --rm senzing/serve-grpc

2. See Parameters for additional parameters.

3. See Examples for using external databases, custom licenses, TLS, etc.

Parameters

• SENZING_TOOLS_AVOID_SERVING
• SENZING_TOOLS_BIND_ADDRESS
• SENZING_TOOLS_CLIENT_CA_CERTIFICATE_FILE
• SENZING_TOOLS_CONFIG_PATH
• SENZING_TOOLS_DATABASE_URL
• SENZING_TOOLS_ENABLE_ALL
• SENZING_TOOLS_ENABLE_HTTP
• SENZING_TOOLS_ENABLE_SZCONFIG
• SENZING_TOOLS_ENABLE_SZCONFIGMANAGER
• SENZING_TOOLS_ENABLE_SZDIAGNOSTIC
• SENZING_TOOLS_ENABLE_SZENGINE
• SENZING_TOOLS_ENABLE_SZPRODUCT
• SENZING_TOOLS_ENGINE_INSTANCE_NAME
• SENZING_TOOLS_ENGINE_LOG_LEVEL
• SENZING_TOOLS_GRPC_PORT
• SENZING_TOOLS_HTTP_PORT
• SENZING_TOOLS_LICENSE_STRING_BASE64
• SENZING_TOOLS_LOG_LEVEL
• SENZING_TOOLS_OBSERVER_ORIGIN
• SENZING_TOOLS_OBSERVER_URL
• SENZING_TOOLS_RESOURCE_PATH
• SENZING_TOOLS_SENZING_DIRECTORY
• SENZING_TOOLS_SERVER_ADDRESS
• SENZING_TOOLS_SERVER_CERTIFICATE_FILE
• SENZING_TOOLS_SERVER_KEEPALIVE_ENFORCEMENT_POLICY_MIN_TIME_IN_SECONDS
• SENZING_TOOLS_SERVER_KEEPALIVE_ENFORCEMENT_POLICY_PERMIT_WITHOUT_STREAM
• SENZING_TOOLS_SERVER_KEEPALIVE_SERVER_PARAMETER_MAX_CONNECTION_AGE_GRACE_IN_SECONDS
• SENZING_TOOLS_SERVER_KEEPALIVE_SERVER_PARAMETER_MAX_CONNECTION_AGE_IN_SECONDS
• SENZING_TOOLS_SERVER_KEEPALIVE_SERVER_PARAMETER_MAX_CONNECTION_IDLE_IN_SECONDS
• SENZING_TOOLS_SERVER_KEEPALIVE_SERVER_PARAMETER_TIME_IN_SECONDS
• SENZING_TOOLS_SERVER_KEEPALIVE_SERVER_PARAMETER_TIMEOUT_IN_SECONDS
• SENZING_TOOLS_SERVER_KEY_FILE
• SENZING_TOOLS_SERVER_KEY_PASSPHRASE
• SENZING_TOOLS_SERVER_MAX_CONCURRENT_STREAMS
• SENZING_TOOLS_SERVER_MAX_HEADER_LIST_SIZE_IN_BYTES
• SENZING_TOOLS_SERVER_MAX_RECEIVE_MESSAGE_SIZE_IN_BYTES
• SENZING_TOOLS_SERVER_MAX_SEND_MESSAGE_SIZE_IN_BYTES
• SENZING_TOOLS_SERVER_READ_BUFFER_SIZE_IN_BYTES
• SENZING_TOOLS_SERVER_WRITE_BUFFER_SIZE_IN_BYTES
• SENZING_TOOLS_SUPPORT_PATH

References

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