Skip to content

Commit

Permalink
#197 Merge main
Browse files Browse the repository at this point in the history
  • Loading branch information
@docktermj
docktermj committed Feb 4, 2025
2 parents d1ad3a9 + aab88e6 commit e4601d0
Show file tree
Hide file tree
Showing 7 changed files with 334 additions and 317 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ and this project adheres to [Semantic Versioning].
- `getDataSources`
- `getTemplateConfigId`

## [0.14.5] - 2025-02-24

### Changed in 0.14.5

- Added `SzEngineFlags`

## [0.14.4] - 2024-12-10

### Changed in 0.14.4
Expand Down
2 changes: 1 addition & 1 deletion response/response_test.go
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// DO NOT EDIT. This code is generated.
// Generated by: sz-sdk-go/bin/generate_senzing_unmarshal_test.py
// Generated for: sz-sdk-go/senzing/unmarshal_test.go
// Generated date: 2025-01-27T18:51:28.623093+00:00
// Generated date: 2025-02-04T21:19:33.387281+00:00

package response

Expand Down
47 changes: 24 additions & 23 deletions senzing/flags.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ const (
SzEntityIncludeRecordMatchingInfo // 15 Include the record matching info for the entity
SzEntityIncludeRecordJSONData // 16 Include the record json data for the entity
Bit18 // 17
SzEntityIncludeRecordFeatures // 18 Include the features identifiers for the records
SzEntityIncludeRecordFeatureIDs // 18 Include the features identifiers for the records
SzEntityIncludeRelatedEntityName // 19 Include the name of the related entities
SzEntityIncludeRelatedMatchingInfo // 20 Include the record matching info of the related entities
SzEntityIncludeRelatedRecordSummary // 21 Include the record summary of the related entities
Expand All @@ -62,22 +62,22 @@ const (

/* flags for including search result feature scores */

SzIncludeFeatureScores // 26 Include feature scores
SzSearchIncludeStats // 27 Include statistics from search results
SzEntityIncludeRecordTypes // 28 Include the record types of the entity
SzEntityIncludeRelatedRecordTypes // 29 Include the record types of the related entities
SzFindPathIncludeMatchingInfo // 30 Include matching info on entity paths
SzEntityIncludeRecordUnmappedData // 31 Include the record unmapped data for the entity
Bit33 // 32
SzFindNetworkIncludeMatchingInfo // 33 Include matching info on entity networks
SzIncludeMatchKeyDetails // 34 Include internal features
SzIncludeRecordFeatureDetails // 35 Include attributes section
SzIncludeRecordFeatureFeatureStats // 36
SzIncludeFeatureScores // 26 Include feature scores
SzSearchIncludeStats // 27 Include statistics from search results
SzEntityIncludeRecordTypes // 28 Include the record types of the entity
SzEntityIncludeRelatedRecordTypes // 29 Include the record types of the related entities
SzFindPathIncludeMatchingInfo // 30 Include matching info on entity paths
SzEntityIncludeRecordUnmappedData // 31 Include the record unmapped data for the entity
SzSearchIncludeAllCandidates // 32
SzFindNetworkIncludeMatchingInfo // 33 Include matching info on entity networks
SzIncludeMatchKeyDetails // 34 Include internal features
SzEntityIncludeRecordFeatureDetails // 35 Include attributes section
SzEntityIncludeRecordFeatureStats // 36 Include the feature statistics
SzSearchIncludeRequest // 37
SzSearchIncludeRequestDetails // 38

/* Reserved */

Bit38 // 37
Bit39 // 38
Bit40 // 39
Bit41 // 40
Bit42 // 41
Expand Down Expand Up @@ -149,15 +149,16 @@ const (
Recommended defaults
*/
const (
SzEntityBriefDefaultFlags = SzEntityIncludeAllRelations | SzEntityIncludeRecordMatchingInfo | SzEntityIncludeRelatedMatchingInfo // The recommended default flag values for a brief entity result.
SzEntityDefaultFlags = SzEntityIncludeAllRelations | SzEntityIncludeEntityName | SzEntityIncludeRecordData | SzEntityIncludeRecordMatchingInfo | SzEntityIncludeRecordSummary | SzEntityIncludeRelatedEntityName | SzEntityIncludeRelatedMatchingInfo | SzEntityIncludeRelatedRecordSummary | SzEntityIncludeRepresentativeFeatures // The recommended default flag values for getting entities.
SzExportDefaultFlags = SzEntityDefaultFlags | SzExportIncludeAllEntities // The recommended default flag values for exporting entities.
SzFindNetworkDefaultFlags = SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzFindNetworkIncludeMatchingInfo // The recommended default flag values for finding entity paths.
SzFindPathDefaultFlags = SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzFindPathIncludeMatchingInfo // The recommended default flag values for finding entity paths.
SzHowEntityDefaultFlags = SzIncludeFeatureScores // The recommended default flag values for how-analysis on entities.
SzRecordDefaultFlags = SzEntityIncludeRecordJSONData // The recommended default flag values for getting records.
SzSearchByAttributesDefaultFlags = SzSearchByAttributesAll // The recommended default flag values for search-by-attributes
SzVirtualEntityDefaultFlags = SzEntityDefaultFlags // The recommended default flag values for virtual-entity-analysis on entities.
SzEntityBriefDefaultFlags = SzEntityIncludeAllRelations | SzEntityIncludeRecordMatchingInfo | SzEntityIncludeRelatedMatchingInfo // The recommended default flag values for a brief entity result.
SzEntityCoreFlags = SzEntityIncludeEntityName | SzEntityIncludeRecordData | SzEntityIncludeRecordMatchingInfo | SzEntityIncludeRecordSummary | SzEntityIncludeRepresentativeFeatures
SzEntityDefaultFlags = SzEntityCoreFlags | SzEntityIncludeAllRelations | SzEntityIncludeRecordSummary | SzEntityIncludeRelatedEntityName | SzEntityIncludeRelatedMatchingInfo // The recommended default flag values for getting entities.
SzExportDefaultFlags = SzEntityDefaultFlags | SzExportIncludeAllEntities // The recommended default flag values for exporting entities.
SzFindNetworkDefaultFlags = SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzFindNetworkIncludeMatchingInfo // The recommended default flag values for finding entity paths.
SzFindPathDefaultFlags = SzEntityIncludeEntityName | SzEntityIncludeRecordSummary | SzFindPathIncludeMatchingInfo // The recommended default flag values for finding entity paths.
SzHowEntityDefaultFlags = SzIncludeFeatureScores // The recommended default flag values for how-analysis on entities.
SzRecordDefaultFlags = SzEntityIncludeRecordJSONData // The recommended default flag values for getting records.
SzSearchByAttributesDefaultFlags = SzSearchByAttributesAll // The recommended default flag values for search-by-attributes
SzVirtualEntityDefaultFlags = SzEntityCoreFlags // The recommended default flag values for virtual-entity-analysis on entities.
SzWhyEntitiesDefaultFlags = SzEntityDefaultFlags | SzEntityIncludeFeatureStats | SzEntityIncludeInternalFeatures | SzIncludeFeatureScores
SzWhyRecordInEntityIDefaultFlags = SzEntityDefaultFlags | SzEntityIncludeFeatureStats | SzEntityIncludeInternalFeatures | SzIncludeFeatureScores // The recommended default flag values for why-analysis on entities.
SzWhyRecordsDefaultFlags = SzEntityDefaultFlags | SzEntityIncludeFeatureStats | SzEntityIncludeInternalFeatures | SzIncludeFeatureScores // The recommended default flag values for why-analysis on entities.
Expand Down
30 changes: 15 additions & 15 deletions senzing/senzing_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ var testCases = []struct {
},
{ // 19
name: "SZ_ENTITY_INCLUDE_RECORD_FEATURES",
actual: SzEntityIncludeRecordFeatures,
actual: SzEntityIncludeRecordFeatureIDs,
expected: 0x0000000000040000,
},
{ // 20
Expand Down Expand Up @@ -192,8 +192,8 @@ var testCases = []struct {
expected: 0x0000000080000000,
},
{ // 33
name: "Bit33",
actual: Bit33,
name: "SZ_SEARCH_INCLUDE_ALL_CANDIDATES",
actual: SzSearchIncludeAllCandidates,
expected: 0x0000000100000000,
},
{ // 34
Expand All @@ -208,22 +208,22 @@ var testCases = []struct {
},
{ // 36
name: "SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS",
actual: SzIncludeRecordFeatureDetails,
actual: SzEntityIncludeRecordFeatureDetails,
expected: 0x0000000800000000,
},
{ // 37
name: "SZ_ENTITY_INCLUDE_RECORD_FEATURE_STATS",
actual: SzIncludeRecordFeatureFeatureStats,
actual: SzEntityIncludeRecordFeatureStats,
expected: 0x0000001000000000,
},
{ // 38
name: "Bit38",
actual: Bit38,
name: "SZ_SEARCH_INCLUDE_REQUEST",
actual: SzSearchIncludeRequest,
expected: 0x0000002000000000,
},
{ // 39
name: "Bit39",
actual: Bit39,
name: "SZ_SEARCH_INCLUDE_REQUEST_DETAILS",
actual: SzSearchIncludeRequestDetails,
expected: 0x0000004000000000,
},
{ // 40
Expand Down Expand Up @@ -374,7 +374,7 @@ var testCases = []struct {
{
name: "SZ_ENTITY_DEFAULT_FLAGS",
actual: SzEntityDefaultFlags,
expected: 0x000000000038FBC0,
expected: 0x000000000018FBC0,
},
{
name: "SZ_ENTITY_BRIEF_DEFAULT_FLAGS",
Expand All @@ -384,7 +384,7 @@ var testCases = []struct {
{
name: "SZ_EXPORT_DEFAULT_FLAGS",
actual: SzExportDefaultFlags,
expected: 0x000000000038FBE1,
expected: 0x000000000018FBE1,
},
{
name: "SZ_FIND_PATH_DEFAULT_FLAGS",
Expand All @@ -399,17 +399,17 @@ var testCases = []struct {
{
name: "SZ_WHY_ENTITIES_DEFAULT_FLAGS",
actual: SzWhyEntitiesDefaultFlags,
expected: 0x0000000005B8FBC0,
expected: 0x000000000598FBC0,
},
{
name: "SZ_WHY_RECORDS_DEFAULT_FLAGS",
actual: SzWhyRecordsDefaultFlags,
expected: 0x0000000005B8FBC0,
expected: 0x000000000598FBC0,
},
{
name: "SZ_WHY_RECORD_IN_ENTITY_DEFAULT_FLAGS",
actual: SzWhyRecordInEntityIDefaultFlags,
expected: 0x0000000005B8FBC0,
expected: 0x000000000598FBC0,
},
{
name: "SZ_HOW_ENTITY_DEFAULT_FLAGS",
Expand All @@ -419,7 +419,7 @@ var testCases = []struct {
{
name: "SZ_VIRTUAL_ENTITY_DEFAULT_FLAGS",
actual: SzVirtualEntityDefaultFlags,
expected: 0x000000000038FBC0,
expected: 0x000000000000F800,
},
{
name: "SZ_SEARCH_BY_ATTRIBUTES_ALL",
Expand Down
14 changes: 8 additions & 6 deletions szerror/doc.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,15 @@ The following is the error type hierarchy:
SzError
├── SzBadInputError
│   ├── SzNotFoundError
│   └── SzUnknownDataSourceError
├── SzConfigurationError
├── SzReplaceConflictError
│ ├── SzNotFoundError
│ └── SzUnknownDataSourceError
├── SzGeneralError
│ ├── SzConfigurationError
│ ├── SzSdkError
│ └── SzReplaceConflictError
├── SzRetryableError
│   ├── SzDatabaseConnectionLostError
│   └── SzRetryTimeoutExceededError
│ ├── SzDatabaseConnectionLostError
│ └── SzRetryTimeoutExceededError
└── SzUnrecoverableError
├── SzDatabaseError
├── SzLicenseError
Expand Down
8 changes: 8 additions & 0 deletions szerror/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,14 @@ const (
SzConfigurationError
SzDatabaseConnectionLostError
SzDatabaseError
SzGeneralError
SzLicenseError
SzNotFoundError
SzNotInitializedError
SzReplaceConflictError
SzRetryableError
SzRetryTimeoutExceededError
SzSdkError
SzUnhandledError
SzUnknownDataSourceError
SzUnrecoverableError
Expand All @@ -49,12 +51,14 @@ var (
ErrSzConfiguration = errors.New(emptyErrorMessage)
ErrSzDatabase = errors.New(emptyErrorMessage)
ErrSzDatabaseConnectionLost = errors.New(emptyErrorMessage)
ErrSzGeneral = errors.New(emptyErrorMessage)
ErrSzLicense = errors.New(emptyErrorMessage)
ErrSzNotFound = errors.New(emptyErrorMessage)
ErrSzNotInitialized = errors.New(emptyErrorMessage)
ErrSzReplaceConflict = errors.New(emptyErrorMessage)
ErrSzRetryable = errors.New(emptyErrorMessage)
ErrSzRetryTimeoutExceeded = errors.New(emptyErrorMessage)
ErrSzSdk = errors.New(emptyErrorMessage)
ErrSzUnhandled = errors.New(emptyErrorMessage)
ErrSzUnknownDataSource = errors.New(emptyErrorMessage)
ErrSzUnrecoverable = errors.New(emptyErrorMessage)
Expand All @@ -67,12 +71,14 @@ var SzErrorTypesList = []TypeIDs{
SzDatabaseConnectionLostError,
SzDatabaseError,
SzError,
SzGeneralError,
SzLicenseError,
SzNotFoundError,
SzNotInitializedError,
SzReplaceConflictError,
SzRetryableError,
SzRetryTimeoutExceededError,
SzSdkError,
SzUnhandledError,
SzUnknownDataSourceError,
SzUnrecoverableError,
Expand All @@ -85,12 +91,14 @@ var SzErrorMap = map[TypeIDs]error{
SzDatabaseConnectionLostError: ErrSzDatabaseConnectionLost,
SzDatabaseError: ErrSzDatabase,
SzError: ErrSz,
SzGeneralError: ErrSzGeneral,
SzLicenseError: ErrSzLicense,
SzNotFoundError: ErrSzNotFound,
SzNotInitializedError: ErrSzNotInitialized,
SzReplaceConflictError: ErrSzReplaceConflict,
SzRetryableError: ErrSzRetryable,
SzRetryTimeoutExceededError: ErrSzRetryTimeoutExceeded,
SzSdkError: ErrSzSdk,
SzUnhandledError: ErrSzUnhandled,
SzUnknownDataSourceError: ErrSzUnknownDataSource,
SzUnrecoverableError: ErrSzUnrecoverable,
Expand Down
Loading

0 comments on commit e4601d0

Please sign in to comment.