Skip to content

Latest commit

 

History

History
147 lines (118 loc) · 5.45 KB

sources.md

File metadata and controls

147 lines (118 loc) · 5.45 KB

Sources

When importing data into Senzing, you can configure one or more sources for the data. Filters and transformations will be run on each record from the source before it is inserted into Senzing.

In addition to the configuration options below, the senzing client can be configured. See Configuring Senzing for more information.

Common configuration options

Option Default Required Description
field_map [ ] NO A mapping of fields from the source to their Senzing counterparts.
name $type NO Name of the source. Defaults to the value of type.
type YES The type of source to use. Should be the name of one of the sources below.

Senzing uses a generic entity specification as their expected format for records. If the field names in your source data do not match those defined in the specification, you must define an appropriate field_map.

CSV

Read records from a local CSV file.

Configuration

The following options are available for this source.

Option Default Required Description
path YES The path to the CSV file.

Example

sources:
  csv:
    type: CSV
    path: /home/senzing/import.csv
    field_map:
      party_id: RECORD_ID
      last_name: PRIMARY_NAME_LAST
      first_name: PRIMARY_NAME_FIRST
      gender: GENDER
      birth_date: DATE_OF_BIRTH
      dr_lic_num: DRIVERS_LICENSE_NUMBER
      dr_lic_state: DRIVERS_LICENSE_STATE
      ssn: SSN_NUMBER

Informix

Query an IBM Informix database for records to import.

Configuration

The following options are available for this source.

Option Default Required Description
database YES Database to read from.
host YES Informix host to connect to.
password YES Password for the database user.
port 9089 NO Port to connect to on the database server.
security nil NO Set to "SSL" in order to utilize TLS1.
schema $username NO Schema that the database is attached to. Defaults to the value of username.
table YES Table that contains the records to be imported.
username YES User with access to the database.

Example

sources:
  informix:
    type: Informix
    host: localhost
    database: people
    table: people
    username: informix
    password: password
    field_map:
      party_id: RECORD_ID
      last_name: PRIMARY_NAME_LAST
      first_name: PRIMARY_NAME_FIRST
      gender: GENDER
      birth_date: DATE_OF_BIRTH
      dr_lic_num: DRIVERS_LICENSE_NUMBER
      dr_lic_state: DRIVERS_LICENSE_STATE
      ssn: SSN_NUMBER

Check out the Import from Informix to see this in action.

MySQL

Query a MySQL or compatible (such as MariaDB) database for records to import.

Configuration

The following options are available for this source.

Option Default Required Description
database YES Database to read from.
host YES Database host to connect to.
password YES Password for the database user.
port 3306 NO Port to connect to on the database server.
security nil NO Set to "SSL" in order to utilize TLS1.
table YES Table that contains the records to be imported.
username YES User with access to the database.

Example

sources:
  informix:
    type: MySQL
    host: localhost
    database: people
    table: people
    username: mysql
    password: password
    field_map:
      party_id: RECORD_ID
      last_name: PRIMARY_NAME_LAST
      first_name: PRIMARY_NAME_FIRST
      gender: GENDER
      birth_date: DATE_OF_BIRTH
      dr_lic_num: DRIVERS_LICENSE_NUMBER
      dr_lic_state: DRIVERS_LICENSE_STATE
      ssn: SSN_NUMBER

Check out the Import from MySQL to see this in action.

Footnotes

  1. Transport Layer Security ↩ ↩2