1
1
# serve-grpc
2
2
3
- If you are beginning your journey with
4
- [ Senzing] ( https://senzing.com/ ) ,
5
- please start with
6
- [ Senzing Quick Start guides] ( https://docs.senzing.com/quickstart/ ) .
7
-
8
- You are in the
9
- [ Senzing Garage] ( https://github.com/senzing-garage )
10
- where projects are "tinkered" on.
3
+ If you are beginning your journey with [ Senzing] ,
4
+ please start with [ Senzing Quick Start guides] .
5
+
6
+ You are in the [ Senzing Garage] where projects are "tinkered" on.
11
7
Although this GitHub repository may help you understand an approach to using Senzing,
12
8
it's not considered to be "production ready" and is not considered to be part of the Senzing product.
13
9
Heck, it may not even be appropriate for your application of Senzing!
@@ -20,34 +16,27 @@ the recommendation is not to use it yet.
20
16
21
17
## Synopsis
22
18
23
- ` serve-grpc ` is a command in the
24
- [ senzing-tools] ( https://github.com/senzing-garage/senzing-tools )
25
- suite of tools.
26
- This command is a
27
- [ gRPC] ( https://grpc.io/ )
28
- server application that supports requests to the Senzing SDK via network access.
19
+ ` serve-grpc ` is a command in the [ senzing-tools] suite of tools.
20
+ This command is a [ gRPC] server application that supports requests to the Senzing SDK via network access.
29
21
30
22
[ ![ Go Reference] ( https://pkg.go.dev/badge/github.com/senzing-garage/serve-grpc.svg )] ( https://pkg.go.dev/github.com/senzing-garage/serve-grpc )
31
23
[ ![ Go Report Card] ( https://goreportcard.com/badge/github.com/senzing-garage/serve-grpc )] ( https://goreportcard.com/report/github.com/senzing-garage/serve-grpc )
32
24
[ ![ License] ( https://img.shields.io/badge/License-Apache2-brightgreen.svg )] ( https://github.com/senzing-garage/serve-grpc/blob/main/LICENSE )
33
25
34
- [ ![ gosec.yaml] ( https://github.com/senzing-garage/serve-grpc/actions/workflows/gosec.yaml/badge.svg )] ( https://github.com/senzing-garage/serve-grpc/actions/workflows/gosec.yaml )
35
26
[ ![ go-test-linux.yaml] ( https://github.com/senzing-garage/serve-grpc/actions/workflows/go-test-linux.yaml/badge.svg )] ( https://github.com/senzing-garage/serve-grpc/actions/workflows/go-test-linux.yaml )
36
27
[ ![ go-test-darwin.yaml] ( https://github.com/senzing-garage/serve-grpc/actions/workflows/go-test-darwin.yaml/badge.svg )] ( https://github.com/senzing-garage/serve-grpc/actions/workflows/go-test-darwin.yaml )
37
28
[ ![ go-test-windows.yaml] ( https://github.com/senzing-garage/serve-grpc/actions/workflows/go-test-windows.yaml/badge.svg )] ( https://github.com/senzing-garage/serve-grpc/actions/workflows/go-test-windows.yaml )
38
29
39
30
## Overview
40
31
41
- ` serve-grpc ` supports the
42
- [ Senzing Protocol Buffer definitions] ( https://github.com/senzing-garage/sz-sdk-proto ) .
43
- Under the covers, the gRPC request is translated by the gRPC server into a Senzing Go SDK API call using
44
- [ senzing/sz-sdk-go-core] ( https://github.com/senzing-garage/sz-sdk-go-core ) .
32
+ ` serve-grpc ` supports the [ Senzing Protocol Buffer definitions] .
33
+ Under the covers, the gRPC request is translated by the gRPC server into a Senzing Go SDK API call using [ senzing/sz-sdk-go-core] .
45
34
The response from the Senzing Go SDK API is returned to the gRPC client.
46
35
47
36
Senzing SDKs for accessing the gRPC server:
48
37
49
- 1 . Go: [ sz-sdk-go-grpc] ( https://github.com/senzing-garage/sz-sdk-go-grpc )
50
- 1 . Python: [ sz-sdk-python-grpc] ( https://github.com/senzing-garage/sz-sdk-python-grpc )
38
+ 1 . Go: [ sz-sdk-go-grpc]
39
+ 1 . Python: [ sz-sdk-python-grpc]
51
40
52
41
A simple demonstration using ` senzing-tools ` and a SQLite database.
53
42
@@ -61,10 +50,8 @@ senzing-tools serve-grpc --enable-all
61
50
62
51
## Install
63
52
64
- 1 . The ` serve-grpc ` command is installed with the
65
- [ senzing-tools] ( https://github.com/senzing-garage/senzing-tools )
66
- suite of tools.
67
- See senzing-tools [ install] ( https://github.com/senzing-garage/senzing-tools#install ) .
53
+ 1 . The ` serve-grpc ` command is installed with the [ senzing-tools] suite of tools.
54
+ See [ senzing-tools install] ( https://github.com/senzing-garage/senzing-tools#install ) .
68
55
69
56
## Use
70
57
@@ -136,22 +123,45 @@ This usage shows how to initialze a database with a Docker container.
136
123
137
124
### Parameters
138
125
139
- - **[SENZING_TOOLS_DATABASE_URL](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_database_url) **
140
- - **[SENZING_TOOLS_ENABLE_ALL](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_enable_all) **
141
- - **[SENZING_TOOLS_ENABLE_G2CONFIG](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_enable_g2config) **
142
- - **[SENZING_TOOLS_ENABLE_G2CONFIGMGR](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_enable_g2configmgr) **
143
- - **[SENZING_TOOLS_ENABLE_G2DIAGNOSTIC](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_enable_g2diagnostic) **
144
- - **[SENZING_TOOLS_ENABLE_G2ENGINE](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_enable_g2engine) **
145
- - **[SENZING_TOOLS_ENABLE_G2PRODUCT](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_enable_g2product) **
146
- - **[SENZING_TOOLS_ENGINE_CONFIGURATION_JSON](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_engine_configuration_json) **
147
- - **[SENZING_TOOLS_ENGINE_LOG_LEVEL](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_engine_log_level) **
148
- - **[SENZING_TOOLS_ENGINE_MODULE_NAME](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_engine_module_name) **
149
- - **[SENZING_TOOLS_GRPC_PORT](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_grpc_port) **
150
- - **[SENZING_TOOLS_LOG_LEVEL](https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_log_level) **
126
+ - **[SENZING_TOOLS_DATABASE_URL]**
127
+ - **[SENZING_TOOLS_ENABLE_ALL]**
128
+ - **[SENZING_TOOLS_ENABLE_G2CONFIG]**
129
+ - **[SENZING_TOOLS_ENABLE_G2CONFIGMGR]**
130
+ - **[SENZING_TOOLS_ENABLE_G2DIAGNOSTIC]**
131
+ - **[SENZING_TOOLS_ENABLE_G2ENGINE]**
132
+ - **[SENZING_TOOLS_ENABLE_G2PRODUCT]**
133
+ - **[SENZING_TOOLS_ENGINE_CONFIGURATION_JSON]**
134
+ - **[SENZING_TOOLS_ENGINE_LOG_LEVEL]**
135
+ - **[SENZING_TOOLS_ENGINE_MODULE_NAME]**
136
+ - **[SENZING_TOOLS_GRPC_PORT]**
137
+ - **[SENZING_TOOLS_LOG_LEVEL]**
151
138
152
139
## References
153
140
154
- 1. [Command reference](https://hub.senzing.com/senzing-tools/senzing-tools_serve-grpc.html)
155
- 1. [Development](docs/development.md)
156
- 1. [Errors](docs/errors.md)
157
- 1. [Examples](docs/examples.md)
141
+ 1. [Command reference]
142
+ 1. [Development]
143
+ 1. [Errors]
144
+ 1. [Examples]
145
+
146
+ [Command reference]: https://hub.senzing.com/senzing-tools/senzing-tools_serve-grpc.html
147
+ [Development]: docs/development.md
148
+ [Errors]: docs/errors.md
149
+ [Examples]: docs/examples.md
150
+ [gRPC]: https://grpc.io/
151
+ [Senzing Protocol Buffer definitions]: https://github.com/senzing-garage/sz-sdk-proto
152
+ [SENZING_TOOLS_DATABASE_URL]: https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_database_url
153
+ [SENZING_TOOLS_ENABLE_ALL]: https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_enable_all
154
+ [SENZING_TOOLS_ENABLE_G2CONFIG]: https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_enable_g2config
155
+ [SENZING_TOOLS_ENABLE_G2CONFIGMGR]: https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_enable_g2configmgr
156
+ [SENZING_TOOLS_ENABLE_G2DIAGNOSTIC]: https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_enable_g2diagnostic
157
+ [SENZING_TOOLS_ENABLE_G2ENGINE]: https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_enable_g2engine
158
+ [SENZING_TOOLS_ENABLE_G2PRODUCT]: https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_enable_g2product
159
+ [SENZING_TOOLS_ENGINE_CONFIGURATION_JSON]: https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_engine_configuration_json
160
+ [SENZING_TOOLS_ENGINE_LOG_LEVEL]: https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_engine_log_level
161
+ [SENZING_TOOLS_ENGINE_MODULE_NAME]: https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_engine_module_name
162
+ [SENZING_TOOLS_GRPC_PORT]: https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_grpc_port
163
+ [SENZING_TOOLS_LOG_LEVEL]: https://github.com/senzing-garage/knowledge-base/blob/main/lists/environment-variables.md#senzing_tools_log_level
164
+ [senzing-tools]: https://github.com/senzing-garage/senzing-tools
165
+ [senzing/sz-sdk-go-core]: https://github.com/senzing-garage/sz-sdk-go-core
166
+ [sz-sdk-go-grpc]: https://github.com/senzing-garage/sz-sdk-go-grpc
167
+ [sz-sdk-python-grpc]: https://github.com/senzing-garage/sz-sdk-python-grpc
0 commit comments