README
¶
explain
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: explain 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
explain is a command in the
senzing-tools
suite of tools.
It is used to explain aspects of senzing-tools.
Overview
explain performs the following:
-
Explains a message. Example:
senzing-tools explain --message-id SZSDK60010032
Install
- The
explaincommand is installed with the senzing-tools suite of tools. See senzing-tools install.
Use
export LD_LIBRARY_PATH=/opt/senzing/g2/lib/
senzing-tools explain [flags]
-
For options and flags:
-
Runtime documentation:
export LD_LIBRARY_PATH=/opt/senzing/g2/lib/ senzing-tools explain --help
-
In addition to the following simple usage examples, there are additional Examples.
Using command line options
-
✏ Specify database using command line option. Example:
export LD_LIBRARY_PATH=/opt/senzing/g2/lib/ senzing-tools explain -
See Parameters for additional parameters.
Using environment variables
-
✏ Specify database using environment variable. Example:
export SENZING_TOOLS_MESSAGE_ID=senzing-60010032 export LD_LIBRARY_PATH=/opt/senzing/g2/lib/ senzing-tools explain -
See Parameters for additional parameters.
Parameters
References
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/explain
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/explain/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/explain/examplepackage"
"github.com/senzing-garage/explain/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)...
}
Source Files
Directories