Senzing API 2.0 - Breaking Changes

Platform Support Changes

MySQL 5.x and MariaDB 5.x support dropped

MySQL 8.0.13 is now the most recent supported version of MySQL.  We don’t explicitly test MariaDB, but 10.x or newer is supported. 

Windows 7 Limited Availability support dropped

Windows 10 or newer are supported.

macOS High Sierra Limited Availability support dropped

macOS Mojave or newer are supported.

Deprecated Functionality

Init functions

The old init(…) functions have been removed.  Any existing use of these functions should be converted to initV2(…) functions.

exportCSVEntityReport

The original exportCSVEntityReport function has been removed.  Any existing use of this function should be converted to exportCSVEntityReportV2.

Python G2Module Interface

The G2Module.py interface was previously deprecated and is no longer shipped.  Any existing use should be converted to the G2Engine interface.

Python G2Audit Interface

The G2Audit Interface has been removed.  There is no direct replacement for it as the interface would not scale beyond small record sets.  Please contact for support to help migrate any particular use.

Python G2Config Entity Classes

The Python functions for adding and delete Entity Classes were removed.  Modifying or adding to the built-in Entity Classes is currently not supported.

Changed Functionality

CSV Export columns names

The ENTITY_NAME column has been split into ENTITY_DESC and RELATED_ENTITY_NAME for consistency.

JSON Export key names

The ENTITY_NAME key has been renamed to ENTITY_DESC.

searchByAttributes Output

The searchByAttributes output now matches the default output for the searchByAttributesV2 function.

Changed G2Engine flags

The original G2Engine flags turned portions of output on and/or off.  This functionality led to inconsistent and unintuitive behavior.

The flags have been overhauled to now consistently add features to the output, so you specify the flags for what you desire to have returned.

There are still composite _DEFAULT_ flags to simplify fulfilling common output needs.

Old Flag	Corresponding Flag	Notes
	G2_EXPORT_INCLUDE_SINGLETONS
	G2_EXPORT_INCLUDE_ALL_RELATIONSHIPS
G2_ENTITY_INCLUDE_NO_RELATIONS	NONE	Unneeded, specify the flags for what you want.
G2_EXPORT_CSV_INCLUDE_FULL_DETAILS	NONE	No replacement as the V2 export allows the columns to be provided included “*” for all columns.
G2_ENTITY_INCLUDE_SINGLE_FEATURES	NONE
G2_ENTITY_INCLUDE_NO_FEATURES	NONE	Specify the flags for what you want.
G2_ENTITY_MINIMAL_FORMAT	NONE	Specify the flags for what you want.
G2_ENTITY_BRIEF_FORMAT	NONE	Specify the flags for what you want.
G2_ENTITY_SHOW_FEATURES_EXPRESSED	G2_ENTITY_OPTION_INCLUDE_INTERNAL_FEATURES
G2_ENTITY_SHOW_FEATURES_STATS	G2_ENTITY_OPTION_INCLUDE_FEATURE_STATS
G2_SEARCH_NO_FEATURE_SCORES	NONE	Specify the flags for what you want.
G2_EXPORT_DEFAULT_REPORT_FLAGS	NONE
	G2_ENTITY_INCLUDE_ENTITY_NAME
	G2_ENTITY_INCLUDE_RECORD_SUMMARY
	G2_ENTITY_INCLUDE_RECORD_DATA
	G2_ENTITY_INCLUDE_RECORD_MATCHING_INFO
	G2_ENTITY_INCLUDE_RECORD_JSON_DATA
	G2_ENTITY_INCLUDE_RECORD_FORMATTED_DATA
	G2_ENTITY_INCLUDE_RECORD_FEATURE_IDS
	G2_ENTITY_INCLUDE_RELATED_ENTITY_NAME
	G2_ENTITY_INCLUDE_RELATED_MATCHING_INFO
	G2_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY
	G2_ENTITY_INCLUDE_RELATED_RECORD_DATA
	G2_SEARCH_INCLUDE_FEATURE_SCORES
	G2_SEARCH_BY_ATTRIBUTES_ALL
	G2_SEARCH_BY_ATTRIBUTES_STRONG
	G2_RECORD_DEFAULT_FLAGS
	G2_ENTITY_BRIEF_DEFAULT_FLAGS