Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Description

FieldDescriptionNote
authenticationThe Authentication object of the Source document is a subset of the full Authentication object in that it only uses the 'username' and 'password' fields. The Database Harvester uses the username and password from the Authentication object as database credentials (if needed).
  • username
  • password - needs to be encrypted username
    Username for the database credentials. 
    password

    Password must be encrypted.

    download the jasypt command line utility to encrypt (link).

     
    databaseTypeThe type of RDBMS to connect to. Valid values currently include: mysql, db2, oracle, mssqlserver, sybase. 
    hostanmeThe hostname of the database server to connect to, i.e. "my.databaseserver.com" in the example above. 
     port The port that the database accepts incoming connections on. 
    databaseNameThe name of the database to connect to. 
    queryThe query field is used to specify the SQL used to perform a full extraction of data for the source. This is generally used the first time the harvester extracts data from a source with incremental extractions being specified using the deltaQuery below. 
    deltaQueryThe deltaQuery field is used to specify the SQL that extracts data from the source RDBS based on one or more delta values, i.e. created or modified date for a record. 
    deleteQueryNote: The deleteQuery functionality of the Database Harvester is not implemented in the Beta version of Infinit.e. 
    primaryKeyPrimary key field in data set, used to help identify whether a record is new or previously harvested. 
    titleRecord field used to populate the document's title field. 
    snippetRecord field used to populate the document's description field. 
    publishedDateRecord field used to populate the document's published date field. 

     

    Examples

    The following input table represents an incident report which will be used by way of example.

    nidccnreportdatetimeshiftoffensemethodblocksiteaddresslatitudelongitudecitystatewardancsmddistrictpsa
    95577811012669Jan 29, 2011 12:00:00 AM UTCUNKTHEFT21300 B/O CONNECTICUT AVE NW38.90992780287290-77.04360677659660WASHINGTONDC22B2B02SECOND208.0

    In the following source example, the database block is configured to pull data from an the incident report provided the publishedDate matches the criteria of the deltaQuery mysql query.

    ...