Create Credential
| Field | Optional | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| type | No | - | No | The value must be "rdb-tables". | "rdb-tables" |
| description | No | - | No | Name of the credential object. | "My RDB Credential" |
| properties | No | - | No | Configuration object | |
| username | No | - | No | User name. | "admin" |
| password | No | - | No | Password. | "adminPassword" |
Example
POST aspire/_api/credentials
{
"type": "rdb-tables",
"description": "My RDB Credential",
"properties": {
"username": "admin",
"password": "adminPassword"
}
}
Create Connection
| Field | Optional | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| type | No | - | No | The value must be "rdb-tables". | "rdb-tables" |
| description | No | - | No | Name of the connection object. | "My RDB Connection" |
| throttlePolicy | Yes | - | No | Id of the throttle policy that applies to this connection object. | "6b235b333a1b" |
| routingPolicies | Yes | [ ] | Yes | The ids of the routing policies that this connection will use. | ["17f75ce7d0c7", "d42780003b36"] |
| credential | No | - | No | Id of the credential | "6b235b333a1b" |
| properties | No | - | No | Configuration object | |
| jdbcUrl | No | - | No | The JDBC url for your RDBMS server and database. Use database marker {DATABASE} to denote the database | "jdbc:mysql://db:3306/{DATABASE}" |
| jdbcDriverJar | No | - | No | Path to the JDBC driver jar file for your RDBMS. | "/lib/myjdbcdriver.jar" |
| jdbcDriverClass | Yes | see notes | No | The name of the default JDBC driver class (if the class name from the META-INF/services/java.sql.Driver file in the driver Jar file should not be used), or if that file does not exist in the driver jar file (Oracle) | "java.sql.Driver" |
| jdbcDriverClasspath | Yes | the driver jar file | No | The class path for external jars required by the jdbc driver | |
| stopOnError | Yes | true | No | When selected, the scan stops if the JDBC driver throws an error while getting a row, and the crawl halts. When unselected, the connector attempts to get subsequent rows | false |
| useSlices | Yes | false | No | Select this option to divide the full SQL into multiple slices. For example,if you have a 10 Million row table to scan, executing the 10 M query will take a while. After it completes, the connector starts sending items. By activating 10 slices, the scan is split into 10 1 Million scans, which takes less time and you can view results faster. This only works when the idColumn contains an integer. | true |
| numSlices | Yes | - | No | The number of SQL slices to split fullSQL. Slicing the full SQL should improve the performance significantly if a big database is to be crawled. Only works when the id column is an integer | 10 |
| percentAsMod | Yes | false | No | Use % Operator for Modulo. Check this option if you want to specify the MODULO operator to use for a particular Database system that doesn't recognize the MOD() function. "MOD()" is available for MySQL, PostgreSQL and Oracle. But systems like Microsoft SQL Server you must check this option | true |
| customFetchSize | Yes | false | No | Check this box if you need to specify a fetch size to the JDBC driver to use when getting results | true |
| fetchSize | Yes | 50 | No | This option indicates to the JDBC driver how it should do paging when retrieving results | 100 |
Example
POST aspire/_api/connections
{
"type": rdb-tables,
"description": "RDB_TEST",
"properties": {
"jdbcUrl":"jdbc:mysql://localhost:3307/{DATABASE}",
"jdbcDriverJar" : "/lib/myjdbcdriver.jar",
"jdbcDriverClass": null,
"jdbcDriverClasspath": null,
"stopOnError": true,
"useSlices": false,
"numSlices": 2,
"percentAsMod": false,
"customFetchSize": true,
"fetchSize": 10
}
Update Connection
| Field | Optional | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| id | No | - | No | Id of the connection to update | "d442adcab4b0", |
| description | Yes | - | No | Name of the connection object. | "My RDB Connection" |
| throttlePolicy | Yes | - | No | Id of the throttle policy that applies to this connection object. | "b3a9-6b235b333a1b" |
| routingPolicies | Yes | [ ] | Yes | The ids of the routing policies that this connection will use. | ["17f75ce7d0c7", "d42780003b36"] |
| credential | Yes | - | No | Id of the credential | "6b235b333a1b" |
| properties | Yes | - | No | Configuration object | |
| (see create connection) |
Example
PUT aspire/_api/connections/89d6632a-a296-426c-adb0-d442adcab4b0
{
"id": "89d6632a-a296-426c-adb0-d442adcab4b0",
"description": "RDB_TEST",
"properties": {
"jdbcUrl":"jdbc:mysql://localhost:3307/{DATABASE}",
"jdbcDriverJar" : "/lib/myjdbcdriver.jar",
"jdbcDriverClass": null,
"jdbcDriverClasspath": null,
"stopOnError": true,
"useSlices": false,
"numSlices": 2,
"percentAsMod": false,
"customFetchSize": true,
"fetchSize": 10
}
Create Seed
| Field | Optional | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| seed | No | - | No | The name of the database. It will replace the marker {DATABASE} used in the field jdbcUrl of connection object | "test_db" |
| type | No | - | No | The value must be "rdb-tables". | "rdb-tables" |
| description | No | - | No | Name of the seed object. | "My RDB Seed" |
| connector | No | - | No | The id of the connector to be used with this seed. The connector type must match the seed type. | "e3ca414b0d31" |
| connection | No | - | No | The id of the connection to be used with this seed. The connection type must match the seed type. | "e4a663fe9ee6" |
| workflows | Yes | [ ] | Yes | The ids of the workflows that will be executed for the documents crawled. | ["5696c3f0bda4"] |
| throttlePolicy | Yes | - | No | Id of the throttle policy that applies to this seed object. | "6b235b333a1b" |
| routingPolicies | Yes | [ ] | Yes | The ids of the routing policies that this seed will use. | ["17f75ce7d0c7", "d42780003b36"] |
| tags | Yes | [ ] | Yes | The tags of the seed. These can be used to filter the seed | ["tag1", "tag2"] |
| properties | No | - | No | Configuration object | |
| fullSQL | No | - | No | Full SQL. Run a "SELECT" query to retrieve all documents. This query is used only for full scans. Use the "WHERE" clause to specify any required condition for crawling just the desired documents. If slicing is enabled, add a "WHERE" clause: "SELECT idCol, col1, col2, col3 FROM data_table WHERE {SLICES} | "SELECT * FROM table" |
| idColumn | No | - | No | The column name that holds the unique key. The default name of the column which holds the value to use as the document id. This column must be present in both discoverySQL and extractionSQL. SQL aliases are NOT supported. | "id" |
| stringIdColumn | Yes | false | No | Check if the unique key is a string value | true |
| postCrawlSQL | Yes | - | No | The SQL to run after a crawl | |
| Incremental Crawl | |||||
| preUpdateSQL | Yes | - | No | The SQL to run before an incremental crawl. This SQL can be used to mark documents for update, save timestamps, clear update tables, etc. as needed to prepare for an incremental crawl | "UPDATE updates_table SET status='I'" |
| updateSQL | No | - | No | The SQL to run during an incremental crawl. This SQL should provide a list of all adds and deletes to the documents in the index. Some field names have special meaning (such as 'title', 'content', 'url', 'id', etc.) - see the wiki for more information. Note the special column, 'action' should report 'I' (for inserts), 'U' (for updates, typically the same as updates for most search engines), and 'D' (for deletes)The SQL to run during an incremental crawl. This SQL should provide a list of all adds and deletes to the documents in the index. Some field names have special meaning (such as 'title', 'content', 'url', 'id', etc.) - see the wiki for more information. Note the special column, 'action' should report 'I' (for inserts), 'U' (for updates, typically the same as updates for most search engines), and 'D' (for deletes) | "SELECT updates_table.sequence, updates_table.id, updates_table.action, students.first_name, students.last_name FROM students RIGHT OUTER JOIN updates_table ON students.id = updates_table.id WHERE updates_table.status = 'I' ORDER BY updates_table.sequence ASC" |
| postUpdateSQL | Yes | - | No | The SQL to run after each record is processed. This SQL can be used un-mark / delete each document in the tables after it is complete. Your SQL may include placeholders for the row id, action, sequence id and whether the processing was successful. These are {documentId}, {action}, {sequenceId} and {failed} respectively | UPDATE updates_table SET status = 'C' WHERE sequence = {sequenceId} |
| postUpdateFailedSQL | Yes | - | No | The SQL to run after each record if processing fails. If not configured, the 'Post update SQL' will be run instead Your SQL may include placeholders for the row id, action, sequence id and whether the processing was successful. These are {documentId}, {action}, {sequenceId} and {failed} respectively | |
| seqColumn | No | - | No | The name of the column in the returned data which holds the sequence number of the update. This is only used for incremental crawls and must match the name returned by the SQL. If the column is aliased using the SQL "AS" construct, you should provide the alias name here. | "sequence" |
| actionColumn | No | - | No | The name of the column in the returned data which holds action of the update (ie Insert, Update or Delete). This is only used for incremental crawls and must match the name returned by the SQL. If the column is aliased using the SQL "AS" construct, you should provide the alias name here | "action" |
| useBounding | Yes | false | No | Checking this option allows incremental crawls to use SQL that is bounded by a condition. When entering SQL you may use the variables {lowerBound} and {upperBound} in a WHERE clause to limit the data collected. The {upperBound} will be calculated at the start of the crawl. The {lowerBound} will be the {upperBound} from the previous crawl. Two types of bounding are available - 'Timestamp' returns the bounds as a 'long' value representing the current system time whilst 'SQL' allows you to define SQL to return the new upper bound when the crawl starts | true |
| boundingSQL | Yes | - | No | The SQL run when the crawl starts to return the new upper bound. The upper bound will be taken from the first column of the first row returned | |
| ACL | |||||
| aclColumn | No (aclColumn or aclSQL) | - | No | The column name that holds the ACLs. Each ACL must be separated by semi-colons and must follow this format: my-domain\userOrGroup@NT | "acl" |
| aclSQL | No (aclColumn or aclSQL) | - | No | The query to use for extracting and building ACLs. This query depends of the Database engine, so the syntax could vary. For example on Oracle: SELECT 'my-domain\\' || user || '@NT;' FROM myTable | "SELECT * FROM table_acl" |
Example
POST aspire/_api/seeds
{
"seed": "test_db",
"type": "rdb-tables",
"description": "RDB_Test",
"properties": {
"idColumn": "id",
"stringIdColumn": true,
"aclSQL": null,
"aclColumn": "acl",
"quoteId": "doNotQuote",
"fullSQL": "SELECT * FROM students",
"preUpdateSQL": "UPDATE updates_table SET status='I'",
"updateSQL": "SELECT updates_table.sequence, updates_table.id, updates_table.action, students.first_name, students.last_name FROM students RIGHT OUTER JOIN updates_table ON students.id = updates_table.id WHERE updates_table.status = 'I' ORDER BY updates_table.sequence ASC",
"postUpdateSQL": "UPDATE updates_table SET status = 'C' WHERE sequence = {sequenceId}",
"seqColumn": "sequence",
"actionColumn": "action"
}
}
Update Seed
| Field | Optional | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| id | No | - | No | Id of the seed to update | "2f287669-d163-4e35-ad17-6bbfe9df3778" |
| (see the "Create seed" for other fields) |
Example
PUT aspire/_api/seeds/2f287669-d163-4e35-ad17-6bbfe9df3778
{
"id": "2f287669-d163-4e35-ad17-6bbfe9df3778",
"seed": "test_db",
"description": "RDB_Test",
"properties": {
"idColumn": "id",
"stringIdColumn": true,
"aclSQL": null,
"aclColumn": "acl",
"quoteId": "doNotQuote",
"fullSQL": "SELECT * FROM students",
"preUpdateSQL": "UPDATE updates_table SET status='I'",
"updateSQL": "SELECT updates_table.sequence, updates_table.id, updates_table.action, students.first_name, students.last_name FROM students RIGHT OUTER JOIN updates_table ON students.id = updates_table.id WHERE updates_table.status = 'I' ORDER BY updates_table.sequence ASC",
"postUpdateSQL": "UPDATE updates_table SET status = 'C' WHERE sequence = {sequenceId}",
"seqColumn": "sequence",
"actionColumn": "action"
}
}
Overview
Content Tools
Copyright © 2024 Accenture
