Database object

Owned by Craig Vitter (Unlicensed)
Last updated: Feb 17, 2012 by AlexI (Unlicensed)Version comment

JSON format

Note that there is a separate overview of how to use the Database Harvester. This page is reference information.

The Source.database object describes how documents can be harvested from a traditional RDBMS database using JDBC drivers.

Source.database object
{
	"databaseType" : "string", // String, type of DB to connect to
					// eg: mysql, db2, oracle, mssqlserver, sybase
	"hostname" : "string", // String, hostname of database server to connect to
	"port" : "string", // String, port database server is listening for connections on
	"databaseName" : "string", // String, name of database containing the data to be extracted
	"query" : "string", // String, SQL query used to retrieve full dataset from source (the first time the source is added)
	"deltaQuery" : "string", // String, SQL query used to retrieve updates from source after the first time through
	"deleteQuery" : "string", // String, not currently implemented
	"primaryKey" : "string", // String, primary key field in data set, used to help identify whether a record is new or previously harvested

	"title" : "string", // String, one of the columns from query/deltaQuery; populates the document's title field
	"snippet" : "string", // String, one of the columns from query/deltaQuery; populates the document's description field
	"publishedDate" : "string", // String, one of the columns from query/deltaQuery; populates the document's published date field
}