lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ctarg...@apache.org
Subject lucene-solr:master: Ref Guide: update DIH docs for SOLR-7383; SOLR-9601; plus major surgery on page layout
Date Tue, 23 May 2017 20:54:53 GMT
Repository: lucene-solr
Updated Branches:
  refs/heads/master 4f16beb05 -> 2319d69fd


Ref Guide: update DIH docs for SOLR-7383; SOLR-9601; plus major surgery on page layout


Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/2319d69f
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/2319d69f
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/2319d69f

Branch: refs/heads/master
Commit: 2319d69fd3d5b67729f31b5796cc1eb68220b664
Parents: 4f16beb
Author: Cassandra Targett <ctargett@apache.org>
Authored: Tue May 23 15:53:53 2017 -0500
Committer: Cassandra Targett <ctargett@apache.org>
Committed: Tue May 23 15:54:35 2017 -0500

----------------------------------------------------------------------
 ...store-data-with-the-data-import-handler.adoc | 950 ++++++++++---------
 1 file changed, 521 insertions(+), 429 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/2319d69f/solr/solr-ref-guide/src/uploading-structured-data-store-data-with-the-data-import-handler.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/uploading-structured-data-store-data-with-the-data-import-handler.adoc b/solr/solr-ref-guide/src/uploading-structured-data-store-data-with-the-data-import-handler.adoc
index af33ad9..9004789 100644
--- a/solr/solr-ref-guide/src/uploading-structured-data-store-data-with-the-data-import-handler.adoc
+++ b/solr/solr-ref-guide/src/uploading-structured-data-store-data-with-the-data-import-handler.adoc
@@ -1,7 +1,7 @@
 = Uploading Structured Data Store Data with the Data Import Handler
 :page-shortname: uploading-structured-data-store-data-with-the-data-import-handler
 :page-permalink: uploading-structured-data-store-data-with-the-data-import-handler.html
-:toclevels: 1
+:page-toclevels: 1
 // Licensed to the Apache Software Foundation (ASF) under one
 // or more contributor license agreements.  See the NOTICE file
 // distributed with this work for additional information
@@ -19,38 +19,42 @@
 // specific language governing permissions and limitations
 // under the License.
 
-Many search applications store the content to be indexed in a structured data store, such as a relational database. The Data Import Handler (DIH) provides a mechanism for importing content from a data store and indexing it. In addition to relational databases, DIH can index content from HTTP based data sources such as RSS and ATOM feeds, e-mail repositories, and structured XML where an XPath processor is used to generate fields.
+Many search applications store the content to be indexed in a structured data store, such as a relational database. The Data Import Handler (DIH) provides a mechanism for importing content from a data store and indexing it.
 
-The `example/example-DIH` directory contains several collections many of the features of the data import handler. To run this "```dih```" example:
+In addition to relational databases, DIH can index content from HTTP based data sources such as RSS and ATOM feeds, e-mail repositories, and structured XML where an XPath processor is used to generate fields.
+
+== DIH Concepts and Terminology
+
+Descriptions of the Data Import Handler use several familiar terms, such as entity and processor, in specific ways, as explained in the table below.
+
+Datasource::
+As its name suggests, a datasource defines the location of the data of interest. For a database, it's a DSN. For an HTTP datasource, it's the base URL.
+
+Entity::
+Conceptually, an entity is processed to generate a set of documents, containing multiple fields, which (after optionally being transformed in various ways) are sent to Solr for indexing. For a RDBMS data source, an entity is a view or table, which would be processed by one or more SQL statements to generate a set of rows (documents) with one or more columns (fields).
+
+Processor::
+An entity processor does the work of extracting content from a data source, transforming it, and adding it to the index. Custom entity processors can be written to extend or replace the ones supplied.
+
+Transformer::
+Each set of fields fetched by the entity may optionally be transformed. This process can modify the fields, create new fields, or generate multiple rows/documents form a single row. There are several built-in transformers in the DIH, which perform functions such as modifying dates and stripping HTML. It is possible to write custom transformers using the publicly available interface.
+
+== Solr's DIH Examples
+
+The `example/example-DIH` directory contains several collections to demonstrate many of the features of the data import handler. These are available with the `dih` example from the <<solr-control-script-reference.adoc#solr-control-script-reference,Solr Control Script>>:
 
 [source,bash]
 ----
 bin/solr -e dih
 ----
 
-For more information about the Data Import Handler, see https://wiki.apache.org/solr/DataImportHandler.
-
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-ConceptsandTerminology]]
-== Concepts and Terminology
+This launches a standalone Solr instance with several collections that correspond to detailed examples. The available examples are `atom`, `db`, `mail`, `solr`, and `tika`.
 
-Descriptions of the Data Import Handler use several familiar terms, such as entity and processor, in specific ways, as explained in the table below.
-
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-
-[cols="30,70",options="header"]
-|===
-|Term |Definition
-|Datasource |As its name suggests, a datasource defines the location of the data of interest. For a database, it's a DSN. For an HTTP datasource, it's the base URL.
-|Entity |Conceptually, an entity is processed to generate a set of documents, containing multiple fields, which (after optionally being transformed in various ways) are sent to Solr for indexing. For a RDBMS data source, an entity is a view or table, which would be processed by one or more SQL statements to generate a set of rows (documents) with one or more columns (fields).
-|Processor |An entity processor does the work of extracting content from a data source, transforming it, and adding it to the index. Custom entity processors can be written to extend or replace the ones supplied.
-|Transformer |Each set of fields fetched by the entity may optionally be transformed. This process can modify the fields, create new fields, or generate multiple rows/documents form a single row. There are several built-in transformers in the DIH, which perform functions such as modifying dates and stripping HTML. It is possible to write custom transformers using the publicly available interface.
-|===
+All examples in this section assume you are running the DIH example server.
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-Configuration]]
-== Configuration
+== Configuring DIH
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-Configuringsolrconfig.xml]]
-=== Configuring `solrconfig.xml`
+=== Configuring solrconfig.xml for DIH
 
 The Data Import Handler has to be registered in `solrconfig.xml`. For example:
 
@@ -67,55 +71,29 @@ The only required parameter is the `config` parameter, which specifies the locat
 
 You can have multiple DIH configuration files. Each file would require a separate definition in the `solrconfig.xml` file, specifying a path to the file.
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-ConfiguringtheDIHConfigurationFile]]
 === Configuring the DIH Configuration File
 
-An annotated configuration file, based on the "```db```" collection in the `dih` example server, is shown below (`example/example-DIH/solr/db/conf/db-data-config.xml`). It extracts fields from the four tables defining a simple product database, with this schema. More information about the parameters and options shown here are described in the sections following.
+An annotated configuration file, based on the `db` collection in the `dih` example server, is shown below (this file is located in `example/example-DIH/solr/db/conf/db-data-config.xml`).
+
+This example shows how to extract fields from four tables defining a simple product database. More information about the parameters and options shown here will be described in the sections following.
 
 [source,xml]
 ----
-<dataConfig>
-<!-- The first element is the dataSource, in this case an HSQLDB database.
-     The path to the JDBC driver and the JDBC URL and login credentials are all specified here.
-     Other permissible attributes include whether or not to autocommit to Solr, the batchsize
-     used in the JDBC connection, a 'readOnly' flag.
-     The password attribute is optional if there is no password set for the DB.
--->
-  <dataSource driver="org.hsqldb.jdbcDriver" url="jdbc:hsqldb:./example-DIH/hsqldb/ex" user="sa" password="secret"/>
-<!--
-Alternately the password can be encrypted as follows. This is the value obtained as a result of the command
-openssl enc -aes-128-cbc -a -salt -in pwd.txt
-password="U2FsdGVkX18QMjY0yfCqlfBMvAB4d3XkwY96L7gfO2o="
-WHen the password is encrypted, you must provide an extra attribute
-encryptKeyFile="/location/of/encryptionkey"
-This file should a text file with a single line containing the encrypt/decrypt password
-
--->
-<!-- A 'document' element follows, containing multiple 'entity' elements.
-     Note that 'entity' elements can be nested, and this allows the entity
-     relationships in the sample database to be mirrored here, so that we can
-     generate a denormalized Solr record which may include multiple features
-     for one item, for instance -->
-  <document>
+<dataConfig> --<1>
 
-<!-- The possible attributes for the entity element are described below.
-     Entity elements may contain one or more 'field' elements, which map
-     the data source field names to Solr fields, and optionally specify
-     per-field transformations -->
-<!-- this entity is the 'root' entity. -->
+  <dataSource driver="org.hsqldb.jdbcDriver" url="jdbc:hsqldb:./example-DIH/hsqldb/ex" user="sa" password="secret"/> --<2>
+  <document> --<3>
     <entity name="item" query="select * from item"
-            deltaQuery="select id from item where last_modified > '${dataimporter.last_index_time}'">
+            deltaQuery="select id from item where last_modified > '${dataimporter.last_index_time}'"> --<4>
       <field column="NAME" name="name" />
 
-<!-- This entity is nested and reflects the one-to-many relationship between an item and its multiple features.
-     Note the use of variables; ${item.ID} is the value of the column 'ID' for the current item
-     ('item' referring to the entity name)  -->
       <entity name="feature"
               query="select DESCRIPTION from FEATURE where ITEM_ID='${item.ID}'"
               deltaQuery="select ITEM_ID from FEATURE where last_modified > '${dataimporter.last_index_time}'"
-              parentDeltaQuery="select ID from item where ID=${feature.ITEM_ID}">
+              parentDeltaQuery="select ID from item where ID=${feature.ITEM_ID}"> --<5>
         <field name="features" column="DESCRIPTION" />
       </entity>
+
       <entity name="item_category"
               query="select CATEGORY_ID from item_category where ITEM_ID='${item.ID}'"
               deltaQuery="select ITEM_ID, CATEGORY_ID from item_category where last_modified > '${dataimporter.last_index_time}'"
@@ -131,6 +109,11 @@ This file should a text file with a single line containing the encrypt/decrypt p
   </document>
 </dataConfig>
 ----
+<1> The first element is the `dataSource`, in this case an HSQLDB database. The path to the JDBC driver and the JDBC URL and login credentials are all specified here. Other permissible attributes include whether or not to autocommit to Solr, the batchsize used in the JDBC connection, and a `readOnly` flag. The password attribute is optional if there is no password set for the DB.
+<2> Alternately the password can be encrypted as follows. This is the value obtained as a result of the command `openssl enc -aes-128-cbc -a -salt -in pwd.txt password="U2FsdGVkX18QMjY0yfCqlfBMvAB4d3XkwY96L7gfO2o="`. When the password is encrypted, you must provide an extra attribute `encryptKeyFile="/location/of/encryptionkey"`. This file should a text file with a single line containing the encrypt/decrypt password.
+<3> A `document` element follows, containing multiple `entity` elements. Note that `entity` elements can be nested, and this allows the entity relationships in the sample database to be mirrored here, so that we can generate a denormalized Solr record which may include multiple features for one item, for instance.
+<4> The possible attributes for the `entity` element are described in later sections. Entity elements may contain one or more `field` elements, which map the data source field names to Solr fields, and optionally specify per-field transformations. This entity is the `root` entity.
+<5> This entity is nested and reflects the one-to-many relationship between an item and its multiple features. Note the use of variables; `${item.ID}` is the value of the column 'ID' for the current item (`item` referring to the entity name).
 
 Datasources can still be specified in `solrconfig.xml`. These must be specified in the defaults section of the handler in `solrconfig.xml`. However, these are not parsed until the main configuration is loaded.
 
@@ -140,15 +123,12 @@ A `reload-config` command is also supported, which is useful for validating a ne
 
 [TIP]
 ====
-
-You can also view the DIH configuration in the Solr Admin UI and there is an interface to import content.
-
+You can also view the DIH configuration in the Solr Admin UI from the <<dataimport-screen.adoc#dataimport-screen,Dataimport Screen>>. It includes an interface to import content.
 ====
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-RequestParameters]]
-==== Request Parameters
+==== DIH Request Parameters
 
-Request parameters can be substituted in configuration with placeholder `${dataimporter.request.paramname}`.
+Request parameters can be substituted in configuration with placeholder `${dataimporter.request._paramname_}`, as in this example:
 
 [source,xml]
 ----
@@ -158,51 +138,61 @@ Request parameters can be substituted in configuration with placeholder `${datai
 	    password=${dataimporter.request.jdbcpassword} />
 ----
 
-Then, these parameters can be passed to the full-import command or defined in the `<defaults>` section in `solrconfig.xml`. This example shows the parameters with the full-import command:
+These parameters can then be passed to the `full-import` command or defined in the `<defaults>` section in `solrconfig.xml`. This example shows the parameters with the full-import command:
 
-`dataimport?command=full-import&jdbcurl=jdbc:hsqldb:./example-DIH/hsqldb/ex&jdbcuser=sa&jdbcpassword=secret`
+[source,bash]
+http://localhost:8983/solr/dih/dataimport?command=full-import&jdbcurl=jdbc:hsqldb:./example-DIH/hsqldb/ex&jdbcuser=sa&jdbcpassword=secret
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-DataImportHandlerCommands]]
-== Data Import Handler Commands
+== DataImportHandler Commands
 
 DIH commands are sent to Solr via an HTTP request. The following operations are supported.
 
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+abort::
+Aborts an ongoing operation. For example: `\http://localhost:8983/solr/dih/dataimport?command=abort`.
+
+delta-import::
+For incremental imports and change detection. Only the <<The SQL Entity Processor,SqlEntityProcessor>> supports delta imports.
++
+For example: `\http://localhost:8983/solr/dih/dataimport?command=delta-import`.
++
+This command supports the same `clean`, `commit`, `optimize` and `debug` parameters as `full-import` command described below.
+
+full-import::
+A Full Import operation can be started with a URL such as `\http://localhost:8983/solr/dih/dataimport?command=full-import`. The command returns immediately.
++
+The operation will be started in a new thread and the _status_ attribute in the response should be shown as _busy_. The operation may take some time depending on the size of dataset. Queries to Solr are not blocked during full-imports.
++
+When a `full-import` command is executed, it stores the start time of the operation in a file located at `conf/dataimport.properties`. This stored timestamp is used when a `delta-import` operation is executed.
++
+Commands available to `full-import` are:
++
+clean:::
+Default is true. Tells whether to clean up the index before the indexing is started.
+commit:::
+Default is true. Tells whether to commit after the operation.
+debug:::
+Default is false. Runs the command in debug mode and is used by the interactive development mode.
++
+Note that in debug mode, documents are never committed automatically. If you want to run debug mode and commit the results too, add `commit=true` as a request parameter.
+entity:::
+The name of an entity directly under the `<document>` tag in the configuration file. Use this to execute one or more entities selectively.
++
+Multiple "entity" parameters can be passed on to run multiple entities at once. If nothing is passed, all entities are executed.
+optimize:::
+Default is true. Tells Solr whether to optimize after the operation.
+synchronous:::
+Blocks request until import is completed. Default is false.
+
+reload-config::
+If the configuration file has been changed and you wish to reload it without restarting Solr, run the command `\http://localhost:8983/solr/dih/dataimport?command=reload-config`
+
+status::
+This command returns statistics on the number of documents created, deleted, queries run, rows fetched, status, and so on. For example:  `\http://localhost:8983/solr/dih/dataimport?command=status`.
+
+show-config::
+This command responds with configuration: `\http://localhost:8983/solr/dih/dataimport?command=show-config`.
 
-[cols="30,70",options="header"]
-|===
-|Command |Description
-|`abort` |Aborts an ongoing operation. The URL is `\http://<host>:<port>/solr/<collection_name>/dataimport?command=abort`.
-|`delta-import` |For incremental imports and change detection. The command is of the form `\http://<host>:<port>/solr/<collection_name>/dataimport?command=delta-import`.  It supports the same clean, commit, optimize and debug parameters as full-import command. Only the SqlEntityProcessor supports delta imports.
-|`full-import` |A Full Import operation can be started with a URL of the form `\http://<host>:<port>/solr/<collection_name>/dataimport?command=full-import`. The command returns immediately. The operation will be started in a new thread and the _status_ attribute in the response should be shown as _busy_. The operation may take some time depending on the size of dataset. Queries to Solr are not blocked during full-imports. When a full-import command is executed, it stores the start time of the operation in a file located at `conf/dataimport.properties`. This stored timestamp is used when a delta-import operation is executed. For a list of parameters that can be passed to this command, see below.
-|`reload-config` a|
-If the configuration file has been changed and you wish to reload it without restarting Solr, run the command
 
-`\http://<host>:<port>/solr/<collection_name>/command=reload-config`
-
-|`status` |The URL is `\http://<host>:<port>/solr/<collection_name>/dataimport?command=status`. It returns statistics on the number of documents created, deleted, queries run, rows fetched, status, and so on.
-|`show-config` |responds with configuration
-|===
-
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-Parametersforthefull-importCommand]]
-=== Parameters for the `full-import` Command
-
-The `full-import` command accepts the following parameters:
-
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-
-[cols="30,70",options="header"]
-|===
-|Parameter |Description
-|clean |Default is true. Tells whether to clean up the index before the indexing is started.
-|commit |Default is true. Tells whether to commit after the operation.
-|debug |Default is false Runs the command in debug mode. It is used by the interactive development mode. Note that in debug mode, documents are never committed automatically. If you want to run debug mode and commit the results too, add `commit=true` as a request parameter.
-|entity |The name of an entity directly under the `<document>` tag in the configuration file. Use this to execute one or more entities selectively. Multiple "entity" parameters can be passed on to run multiple entities at once. If nothing is passed, all entities are executed.
-|optimize |Default is true. Tells Solr whether to optimize after the operation.
-|synchronous |Blocks request until import is completed. Default is `false`.
-|===
-
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-PropertyWriter]]
 == Property Writer
 
 The `propertyWriter` element defines the date format and locale for use with delta queries. It is an optional configuration. Add the element to the DIH configuration file, directly under the `dataConfig` element.
@@ -215,19 +205,25 @@ The `propertyWriter` element defines the date format and locale for use with del
 
 The parameters available are:
 
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+dateFormat::
+A `java.text.SimpleDateFormat` to use when converting the date to text. The default is `yyyy-MM-dd HH:mm:ss`.
+
+type::
+The implementation class. Use `SimplePropertiesWriter` for non-SolrCloud installations. If using SolrCloud, use `ZKPropertiesWriter`.
++
+If this is not specified, it will default to the appropriate class depending on if SolrCloud mode is enabled.
+
+directory::
+Used with the `SimplePropertiesWriter` only. The directory for the properties file. If not specified, the default is `conf`.
 
-[cols="30,70",options="header"]
-|===
-|Parameter |Description
-|dateFormat |A java.text.SimpleDateFormat to use when converting the date to text. The default is "yyyy-MM-dd HH:mm:ss".
-|type |The implementation class. Use `SimplePropertiesWriter` for non-SolrCloud installations. If using SolrCloud, use `ZKPropertiesWriter`. If this is not specified, it will default to the appropriate class depending on if SolrCloud mode is enabled.
-|directory |Used with the `SimplePropertiesWriter` only). The directory for the properties file. If not specified, the default is "conf".
-|filename |Used with the `SimplePropertiesWriter` only). The name of the properties file. If not specified, the default is the requestHandler name (as defined in `solrconfig.xml`, appended by ".properties" (i.e., "dataimport.properties").
-|locale |The locale. If not defined, the ROOT locale is used. It must be specified as language-country (https://tools.ietf.org/html/bcp47[BCP 47 language tag]). For example, `en-US`.
-|===
+filename::
+Used with the `SimplePropertiesWriter` only. The name of the properties file.
++
+If not specified, the default is the requestHandler name (as defined in `solrconfig.xml`, appended by ".properties" (such as, `dataimport.properties`).
+
+locale::
+The locale. If not defined, the ROOT locale is used. It must be specified as language-country (https://tools.ietf.org/html/bcp47[BCP 47 language tag]). For example, `en-US`.
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-DataSources]]
 == Data Sources
 
 A data source specifies the origin of data and its type. Somewhat confusingly, some data sources are configured within the associated entity processor. Data sources can also be specified in `solrconfig.xml`, which is useful when you have multiple environments (for example, development, QA, and production) differing only in their data sources.
@@ -238,12 +234,10 @@ The mandatory attributes for a data source definition are its name and type. The
 
 The types of data sources available are described below.
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-ContentStreamDataSource]]
 === ContentStreamDataSource
 
 This takes the POST data as the data source. This can be used with any EntityProcessor that uses a `DataSource<Reader>`.
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-FieldReaderDataSource]]
 === FieldReaderDataSource
 
 This can be used where a database field contains XML which you wish to process using the XPathEntityProcessor. You would set up a configuration with both JDBC and FieldReader data sources, and two entities, as follows:
@@ -255,68 +249,56 @@ This can be used where a database field contains XML which you wish to process u
 <document>
 
   <!-- processor for database -->
-
   <entity name ="e1" dataSource="a1" processor="SqlEntityProcessor" pk="docid"
           query="select * from t1 ...">
 
     <!-- nested XpathEntity; the field in the parent which is to be used for
-         Xpath is set in the "datafield" attribute in place of the "url" attribute -->
-
+         XPath is set in the "datafield" attribute in place of the "url" attribute -->
     <entity name="e2" dataSource="a2" processor="XPathEntityProcessor"
             dataField="e1.fieldToUseForXPath">
 
-      <!-- Xpath configuration follows -->
+      <!-- XPath configuration follows -->
       ...
     </entity>
   </entity>
 </document>
 ----
 
-The FieldReaderDataSource can take an `encoding` parameter, which will default to "UTF-8" if not specified.It must be specified as language-country. For example, `en-US`.
+The `FieldReaderDataSource` can take an `encoding` parameter, which will default to "UTF-8" if not specified. It must be specified as language-country. For example, `en-US`.
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-FileDataSource]]
 === FileDataSource
 
-This can be used like an <<UploadingStructuredDataStoreDatawiththeDataImportHandler-URLDataSource,URLDataSource>>, but is used to fetch content from files on disk. The only difference from URLDataSource, when accessing disk files, is how a pathname is specified.
+This can be used like a <<URLDataSource>>, but is used to fetch content from files on disk. The only difference from `URLDataSource`, when accessing disk files, is how a pathname is specified.
 
 This data source accepts these optional attributes.
 
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+basePath::
+The base path relative to which the value is evaluated if it is not absolute.
 
-[cols="30,70",options="header"]
-|===
-|Optional Attribute |Description
-|basePath |The base path relative to which the value is evaluated if it is not absolute.
-|encoding |Defines the character encoding to use. If not defined, UTF-8 is used.
-|===
+encoding::
+Defines the character encoding to use. If not defined, UTF-8 is used.
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-JdbcDataSource]]
 === JdbcDataSource
 
-This is the default datasource. It's used with the <<UploadingStructuredDataStoreDatawiththeDataImportHandler-TheSQLEntityProcessor,SqlEntityProcessor>>. See the example in the <<UploadingStructuredDataStoreDatawiththeDataImportHandler-FieldReaderDataSource,FieldReaderDataSource>> section for details on configuration. `JdbcDatasource` supports at least the following attributes: .
+This is the default datasource. It's used with the <<The SQL Entity Processor,SqlEntityProcessor>>. See the example in the <<FieldReaderDataSource>> section for details on configuration. `JdbcDatasource` supports at least the following attributes:
 
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+driver, url, user, password, encryptKeyFile::
+Usual JDBC connection properties.
 
-[cols="30,70",options="header"]
-|===
-|Attributes |Description
-|driver, url, user, password, encryptKeyFile |Usual jdbc connection properties
-|`batchSize`
- a|
-Passed to Statement#setFetchSize, default value 500.
+batchSize::
 
+Passed to `Statement#setFetchSize`, default value 500.
++
 For MySQL driver, which doesn't honor fetchSize and pulls whole resultSet, which often lead to OutOfMemoryError.
-
++
 In this case, set `batchSize=-1` that pass setFetchSize(Integer.MIN_VALUE), and switch result set to pull row by row
 
-|===
 
-All of them substitute properties via $\{placeholders}.
+All of them substitute properties via `${placeholders}`.
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-URLDataSource]]
 === URLDataSource
 
-This data source is often used with XPathEntityProcessor to fetch content from an underlying `file://` or `http://` location. Here's an example:
+This data source is often used with <<The XPathEntityProcessor,XPathEntityProcessor>> to fetch content from an underlying `file://` or `http://` location. Here's an example:
 
 [source,xml]
 ----
@@ -330,49 +312,88 @@ This data source is often used with XPathEntityProcessor to fetch content from a
 
 The URLDataSource type accepts these optional parameters:
 
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+baseURL::
+Specifies a new baseURL for pathnames. You can use this to specify host/port changes between Dev/QA/Prod environments. Using this attribute isolates the changes to be made to the `solrconfig.xml`
+
+connectionTimeout::
+Specifies the length of time in milliseconds after which the connection should time out. The default value is 5000ms.
+
+encoding::
+By default the encoding in the response header is used. You can use this property to override the default encoding.
+
+readTimeout::
+Specifies the length of time in milliseconds after which a read operation should time out. The default value is 10000ms.
 
-[cols="30,70",options="header"]
-|===
-|Optional Parameter |Description
-|baseURL |Specifies a new baseURL for pathnames. You can use this to specify host/port changes between Dev/QA/Prod environments. Using this attribute isolates the changes to be made to the `solrconfig.xml`
-|connectionTimeout |Specifies the length of time in milliseconds after which the connection should time out. The default value is 5000ms.
-|encoding |By default the encoding in the response header is used. You can use this property to override the default encoding.
-|readTimeout |Specifies the length of time in milliseconds after which a read operation should time out. The default value is 10000ms.
-|===
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-EntityProcessors]]
 == Entity Processors
 
 Entity processors extract data, transform it, and add it to a Solr index. Examples of entities include views or tables in a data store.
 
-Each processor has its own set of attributes, described in its own section below. In addition, there are non-specific attributes common to all entities which may be specified.
-
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-
-[cols="30,70",options="header"]
-|===
-|Attribute |Use
-|dataSource |The name of a data source. If there are multiple data sources defined, use this attribute with the name of the data source for this entity.
-|name |Required. The unique name used to identify an entity.
-|pk |The primary key for the entity. It is optional, and required only when using delta-imports. It has no relation to the uniqueKey defined in `schema.xml` but they can both be the same. It is mandatory if you do delta-imports and then refers to the column name in `${dataimporter.delta.<column-name>`} which is used as the primary key.
-|processor |Default is SqlEntityProcessor. Required only if the datasource is not RDBMS.
-|onError |Permissible values are (abort|skip|continue) . The default value is 'abort'. 'Skip' skips the current document. 'Continue' ignores the error and processing continues.
-|preImportDeleteQuery |Before a full-import command, use this query this to cleanup the index instead of using '*:*'. This is honored only on an entity that is an immediate sub-child of `<document>`.
-|postImportDeleteQuery |Similar to the above, but executed after the import has completed.
-|rootEntity |By default the entities immediately under the `<document>` are root entities. If this attribute is set to false, the entity directly falling under that entity will be treated as the root entity (and so on). For every row returned by the root entity, a document is created in Solr.
-|transformer |Optional. One or more transformers to be applied on this entity.
-|cacheImpl |Optional. A class (which must implement `DIHCache`) to use for caching this entity when doing lookups from an entity which wraps it. Provided implementation is "```SortedMapBackedCache```".
-|cacheKey |The name of a property of this entity to use as a cache key if `cacheImpl` is specified.
-|cacheLookup |An entity + property name that will be used to lookup cached instances of this entity if `cacheImpl` is specified.
-|where |an alternative way to specify `cacheKey` and `cacheLookup` concatenated with '='. eg `where="CODE=People.COUNTRY_CODE"` is equal to `cacheKey="CODE" cacheLookup="People.COUNTRY_CODE"`
-|child="true" |Enables indexing document blocks aka <<uploading-data-with-index-handlers.adoc#uploading-data-with-index-handlers,Nested Child Documents>> for searching with <<other-parsers.adoc#other-parsers,Block Join Query Parsers>>. It can be only specified on `<entity>` under another root entity. It switches from default behavior (merging field values) to nesting documents as children documents. Note: parent `<entity>` should add a field which is used as a parent filter in query time.
-|join="zipper" |Enables merge join aka "zipper" algorithm for joining parent and child entities without cache. It should be specified at child (nested) `<entity>`. It implies that parent and child queries return results ordered by keys, otherwise it throws an exception. Keys should be specified either with `where` attribute or with `cacheKey` and `cacheLookup`.
-|===
+Each processor has its own set of attributes, described in its own section below. In addition, there are several attributes common to all entities which may be specified:
+
+dataSource::
+The name of a data source. If there are multiple data sources defined, use this attribute with the name of the data source for this entity.
+
+name::
+Required. The unique name used to identify an entity.
+
+pk::
+The primary key for the entity. It is optional, and required only when using delta-imports. It has no relation to the uniqueKey defined in `schema.xml` but they can both be the same.
++
+This attribute is mandatory if you do delta-imports and then refer to the column name in `${dataimporter.delta.<column-name>}` which is used as the primary key.
+
+processor::
+Default is <<The SQL Entity Processor,SqlEntityProcessor>>. Required only if the datasource is not RDBMS.
 
+onError::
+Defines what to do if an error is encountered.
++
+Permissible values are:
+
+abort::: Stops the import.
+
+skip::: Skips the current document.
+
+continue::: Ignores the error and processing continues.
+
+preImportDeleteQuery::
+Before a `full-import` command, use this query this to cleanup the index instead of using `\*:*`. This is honored only on an entity that is an immediate sub-child of `<document>`.
+
+postImportDeleteQuery::
+Similar to `preImportDeleteQuery`, but it executes after the import has completed.
+
+rootEntity::
+By default the entities immediately under `<document>` are root entities. If this attribute is set to false, the entity directly falling under that entity will be treated as the root entity (and so on). For every row returned by the root entity, a document is created in Solr.
+
+transformer::
+Optional. One or more transformers to be applied on this entity.
+
+cacheImpl::
+Optional. A class (which must implement `DIHCache`) to use for caching this entity when doing lookups from an entity which wraps it. Provided implementation is `SortedMapBackedCache`.
+
+cacheKey::
+The name of a property of this entity to use as a cache key if `cacheImpl` is specified.
+
+cacheLookup::
+An entity + property name that will be used to lookup cached instances of this entity if `cacheImpl` is specified.
+
+where::
+An alternative way to specify `cacheKey` and `cacheLookup` concatenated with '='.
++
+For example, `where="CODE=People.COUNTRY_CODE"` is equivalent to `cacheKey="CODE" cacheLookup="People.COUNTRY_CODE"`
+
+child="true"::
+Enables indexing document blocks aka <<uploading-data-with-index-handlers.adoc#uploading-data-with-index-handlers,Nested Child Documents>> for searching with <<other-parsers.adoc#other-parsers,Block Join Query Parsers>>. It can be only specified on the `<entity>` element under another root entity. It switches from default behavior (merging field values) to nesting documents as children documents.
++
+Note: parent `<entity>` should add a field which is used as a parent filter in query time.
+
+join="zipper"::
+Enables merge join, aka "zipper" algorithm, for joining parent and child entities without cache. It should be specified at child (nested) `<entity>`. It implies that parent and child queries return results ordered by keys, otherwise it throws an exception. Keys should be specified either with `where` attribute or with `cacheKey` and `cacheLookup`.
+
+=== Entity Caching
 Caching of entities in DIH is provided to avoid repeated lookups for same entities again and again. The default `SortedMapBackedCache` is a `HashMap` where a key is a field in the row and the value is a bunch of rows for that same key.
 
-In the example below, each `manufacturer` entity is cached using the '`id`' property as a cache key. Cache lookups will be performed for each `product` entity based on the product's "```manu```" property. When the cache has no data for a particular key, the query is run and the cache is populated
+In the example below, each `manufacturer` entity is cached using the `id` property as a cache key. Cache lookups will be performed for each `product` entity based on the product's `manu` property. When the cache has no data for a particular key, the query is run and the cache is populated
 
 [source,xml]
 ----
@@ -382,101 +403,153 @@ In the example below, each `manufacturer` entity is cached using the '`id`' prop
 </entity>
 ----
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-TheSQLEntityProcessor]]
 === The SQL Entity Processor
 
-The SqlEntityProcessor is the default processor. The associated <<UploadingStructuredDataStoreDatawiththeDataImportHandler-JdbcDataSource,data source>> should be a JDBC URL.
+The SqlEntityProcessor is the default processor. The associated <<JdbcDataSource>> should be a JDBC URL.
+
+The entity attributes specific to this processor are shown in the table below. These are in addition to the attributes common to all entity processors described above.
 
-The entity attributes specific to this processor are shown in the table below.
+query::
+Required. The SQL query used to select rows.
 
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+deltaQuery::
+SQL query used if the operation is delta-import. This query selects the primary keys of the rows which will be parts of the delta-update. The pks will be available to the deltaImportQuery through the variable `${dataimporter.delta.<column-name>}`.
 
-[cols="30,70",options="header"]
-|===
-|Attribute |Use
-|query |Required. The SQL query used to select rows.
-|deltaQuery |SQL query used if the operation is delta-import. This query selects the primary keys of the rows which will be parts of the delta-update. The pks will be available to the deltaImportQuery through the variable `${dataimporter.delta.<column-name>`}.
-|parentDeltaQuery |SQL query used if the operation is delta-import.
-|deletedPkQuery |SQL query used if the operation is delta-import.
-|deltaImportQuery |SQL query used if the operation is delta-import. If this is not present, DIH tries to construct the import query by(after identifying the delta) modifying the 'query' (this is error prone). There is a namespace `${dataimporter.delta.<column-name>`} which can be used in this query. For example, `select * from tbl where id=${dataimporter.delta.id`}.
-|===
+parentDeltaQuery::
+SQL query used if the operation is `delta-import`.
+
+deletedPkQuery::
+SQL query used if the operation is `delta-import`.
+
+deltaImportQuery::
+SQL query used if the operation is `delta-import`. If this is not present, DIH tries to construct the import query by (after identifying the delta) modifying the 'query' (this is error prone).
++
+There is a namespace `${dataimporter.delta.<column-name>}` which can be used in this query. For example, `select * from tbl where id=${dataimporter.delta.id}`.
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-TheXPathEntityProcessor]]
 === The XPathEntityProcessor
 
-This processor is used when indexing XML formatted data. The data source is typically <<UploadingStructuredDataStoreDatawiththeDataImportHandler-URLDataSource,URLDataSource>> or <<UploadingStructuredDataStoreDatawiththeDataImportHandler-FileDataSource,FileDataSource>>. Xpath can also be used with the <<UploadingStructuredDataStoreDatawiththeDataImportHandler-TheFileListEntityProcessor,FileListEntityProcessor>> described below, to generate a document from each file.
+This processor is used when indexing XML formatted data. The data source is typically <<URLDataSource>> or <<FileDataSource>>. XPath can also be used with the <<The FileListEntityProcessor,FileListEntityProcessor>> described below, to generate a document from each file.
+
+The entity attributes unique to this processor are shown below. These are in addition to the attributes common to all entity processors described above.
+
+Processor::
+Required. Must be set to `XpathEntityProcessor`.
 
-The entity attributes unique to this processor are shown below.
+url::
+Required. The HTTP URL or file location.
 
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+stream::
+Optional: Set to true for a large file or download.
 
-[cols="30,70",options="header"]
-|===
-|Attribute |Use
-|Processor |Required. Must be set to "XpathEntityProcessor".
-|url |Required. HTTP URL or file location.
-|stream |Optional: Set to true for a large file or download.
-|forEach |Required unless you define `useSolrAddSchema`. The Xpath expression which demarcates each record. This will be used to set up the processing loop.
-|xsl |Optional: Its value (a URL or filesystem path) is the name of a resource used as a preprocessor for applying the XSL transformation.
-|useSolrAddSchema |Set this to true if the content is in the form of the standard Solr update XML schema.
-|===
+forEach::
+Required unless you define `useSolrAddSchema`. The XPath expression which demarcates each record. This will be used to set up the processing loop.
 
-Each field element in the entity can have the following attributes as well as the default ones.
+xsl::
+Optional: Its value (a URL or filesystem path) is the name of a resource used as a preprocessor for applying the XSL transformation.
 
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+useSolrAddSchema::
+Set this to true if the content is in the form of the standard Solr update XML schema.
 
-[cols="30,70",options="header"]
-|===
-|Attribute |Use
-|xpath |Required. The XPath expression which will extract the content from the record for this field. Only a subset of Xpath syntax is supported.
-|commonField |Optional. If true, then when this field is encountered in a record it will be copied to future records when creating a Solr document.
-|flatten a|
-Optional: If set to true, then any children text nodes are collected to form the value of a field. image::images/icons/emoticons/warning.png[(warning)]
- The default value is false, meaning that
+Each `<field>` element in the entity can have the following attributes as well as the default ones.
 
-if there are any sub-elements of the node pointed to by the XPath expression, they will be quietly omitted.
+xpath::
+Required. The XPath expression which will extract the content from the record for this field. Only a subset of XPath syntax is supported.
 
-|===
+commonField::
+Optional. If true, then when this field is encountered in a record it will be copied to future records when creating a Solr document.
 
-Here is an example from the "```rss```" collection in the `dih` example (`example/example-DIH/solr/rss/conf/rss-data-config.xml`):
+flatten::
+Optional. If set to true, then any children text nodes are collected to form the value of a field.
++
+[WARNING]
+The default value is false, meaning that if there are any sub-elements of the node pointed to by the XPath expression, they will be quietly omitted.
+
+Here is an example from the `atom` collection in the `dih` example (data-config file found at `example/example-DIH/solr/atom/conf/atom-data-config.xml`):
 
 [source,xml]
 ----
-<!-- slashdot RSS Feed --->
 <dataConfig>
-  <dataSource type="HttpDataSource" />
-    <document>
-      <entity name="slashdot"
-              pk="link"
-              url="http://rss.slashdot.org/Slashdot/slashdot"
-              processor="XPathEntityProcessor"
-              transformer="DateFormatTransformer"
-              forEach="/RDF/channel | /RDF/item" >
-          <!-- NOTE: forEach sets up a processing loop ; here there are two expressions -->
-      <field column="source" xpath="/RDF/channel/title" commonField="true" />
-      <field column="source-link" xpath="/RDF/channel/link" commonField="true"/>
-      <field column="subject" xpath="/RDF/channel/subject" commonField="true" />
-      <field column="title" xpath="/RDF/item/title" />
-      <field column="link" xpath="/RDF/item/link" />
-      <field column="description" xpath="/RDF/item/description" />
-      <field column="creator" xpath="/RDF/item/creator" />
-      <field column="item-subject" xpath="/RDF/item/subject" />
-      <field column="date" xpath="/RDF/item/date"
-             dateTimeFormat="yyyy-MM-dd'T'hh:mm:ss" />
-      <field column="slash-department" xpath="/RDF/item/department" />
-      <field column="slash-section" xpath="/RDF/item/section" />
-      <field column="slash-comments" xpath="/RDF/item/comments" />
+  <dataSource type="URLDataSource"/>
+  <document>
+
+    <entity name="stackoverflow"
+            url="http://stackoverflow.com/feeds/tag/solr"
+            processor="XPathEntityProcessor"
+            forEach="/feed|/feed/entry"
+            transformer="HTMLStripTransformer,RegexTransformer">
+
+      <!-- Pick this value up from the feed level and apply to all documents -->
+      <field column="lastchecked_dt" xpath="/feed/updated" commonField="true"/>
+
+      <!-- Keep only the final numeric part of the URL -->
+      <field column="id" xpath="/feed/entry/id" regex=".*/" replaceWith=""/>
+
+      <field column="title"    xpath="/feed/entry/title"/>
+      <field column="author"   xpath="/feed/entry/author/name"/>
+      <field column="category" xpath="/feed/entry/category/@term"/>
+      <field column="link"     xpath="/feed/entry/link[@rel='alternate']/@href"/>
+
+      <!-- Use transformers to convert HTML into plain text.
+        There is also an UpdateRequestProcess to trim remaining spaces.
+      -->
+      <field column="summary" xpath="/feed/entry/summary" stripHTML="true" regex="( |\n)+" replaceWith=" "/>
+
+      <!-- Ignore namespaces when matching XPath -->
+      <field column="rank" xpath="/feed/entry/rank"/>
+
+      <field column="published_dt" xpath="/feed/entry/published"/>
+      <field column="updated_dt" xpath="/feed/entry/updated"/>
     </entity>
+
   </document>
 </dataConfig>
 ----
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-TheMailEntityProcessor]]
 === The MailEntityProcessor
 
-The MailEntityProcessor uses the Java Mail API to index email messages using the IMAP protocol. The MailEntityProcessor works by connecting to a specified mailbox using a username and password, fetching the email headers for each message, and then fetching the full email contents to construct a document (one document for each mail message).
+The MailEntityProcessor uses the Java Mail API to index email messages using the IMAP protocol.
+
+The MailEntityProcessor works by connecting to a specified mailbox using a username and password, fetching the email headers for each message, and then fetching the full email contents to construct a document (one document for each mail message).
+
+The entity attributes unique to the MailEntityProcessor are shown below. These are in addition to the attributes common to all entity processors described above.
+
+processor::
+Required. Must be set to `MailEntityProcessor`.
+
+user::
+Required. Username for authenticating to the IMAP server; this is typically the email address of the mailbox owner.
+
+password::
+Required. Password for authenticating to the IMAP server.
+
+host::
+Required. The IMAP server to connect to.
+
+protocol::
+Required. The IMAP protocol to use, valid values are: imap, imaps, gimap, and gimaps.
+
+fetchMailsSince::
+Optional. Date/time used to set a filter to import messages that occur after the specified date; expected format is: `yyyy-MM-dd HH:mm:ss`.
+
+folders::
+Required. Comma-delimited list of folder names to pull messages from, such as "inbox".
 
-Here is an example from the "```mail```" collection of the `dih` example (`example/example-DIH/mail/conf/mail-data-config.xml`):
+recurse::
+Optional. Default is true. Flag to indicate if the processor should recurse all child folders when looking for messages to import.
+
+include::
+Optional. Comma-delimited list of folder patterns to include when processing folders (can be a literal value or regular expression).
+
+exclude::
+Optional. Comma-delimited list of folder patterns to exclude when processing folders (can be a literal value or regular expression). Excluded folder patterns take precedence over include folder patterns.
+
+processAttachement or processAttachments::
+Optional. Default is true. Use Tika to process message attachments.
+
+includeContent::
+Optional. Default is true. Include the message body when constructing Solr documents for indexing.
+
+Here is an example from the `mail` collection of the `dih` example (data-config file found at `example/example-DIH/mail/conf/mail-data-config.xml`):
 
 [source,xml]
 ----
@@ -487,119 +560,128 @@ Here is an example from the "```mail```" collection of the `dih` example (`examp
               password="password"
               host="imap.gmail.com"
               protocol="imaps"
-              fetchMailsSince="2009-09-20 00:00:00"
+              fetchMailsSince="2014-06-30 00:00:00"
               batchSize="20"
               folders="inbox"
               processAttachement="false"
-              name="sample_entity"/>
+              name="mail_entity"/>
   </document>
 </dataConfig>
 ----
 
-The entity attributes unique to the MailEntityProcessor are shown below.
+==== Importing New Emails Only
 
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+After running a full import, the MailEntityProcessor keeps track of the timestamp of the previous import so that subsequent imports can use the fetchMailsSince filter to only pull new messages from the mail server. This occurs automatically using the DataImportHandler `dataimport.properties` file (stored in `conf`).
 
-[cols="30,70",options="header"]
-|===
-|Attribute |Use
-|processor |Required. Must be set to "MailEntityProcessor".
-|user |Required. Username for authenticating to the IMAP server; this is typically the email address of the mailbox owner.
-|password |Required. Password for authenticating to the IMAP server.
-|host |Required. The IMAP server to connect to.
-|protocol |Required. The IMAP protocol to use, valid values are: imap, imaps, gimap, and gimaps.
-|fetchMailsSince |Optional. Date/time used to set a filter to import messages that occur after the specified date; expected format is: `yyyy-MM-dd HH:mm:ss`.
-|folders |Required. Comma-delimited list of folder names to pull messages from, such as "inbox".
-|recurse |Optional (default is true). Flag to indicate if the processor should recurse all child folders when looking for messages to import.
-|include |Optional. Comma-delimited list of folder patterns to include when processing folders (can be a literal value or regular expression).
-|exclude |Optional. Comma-delimited list of folder patterns to exclude when processing folders (can be a literal value or regular expression); excluded folder patterns take precedence over include folder patterns.
-a|
-processAttachement
+For instance, if you set `fetchMailsSince="2014-08-22 00:00:00"` in your `mail-data-config.xml`, then all mail messages that occur after this date will be imported on the first run of the importer. Subsequent imports will use the date of the previous import as the `fetchMailsSince` filter, so that only new emails since the last import are indexed each time.
 
-or
+==== GMail Extensions
 
-processAttachments
+When connecting to a GMail account, you can improve the efficiency of the MailEntityProcessor by setting the protocol to *gimap* or *gimaps*.
 
- |Optional (default is true). Use Tika to process message attachments.
-|includeContent |Optional (default is true). Include the message body when constructing Solr documents for indexing.
-|===
+This allows the processor to send the `fetchMailsSince` filter to the GMail server to have the date filter applied on the server, which means the processor only receives new messages from the server. However, GMail only supports date granularity, so the server-side filter may return previously seen messages if run more than once a day.
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-ImportingNewEmailsOnly]]
-==== Importing New Emails Only
+=== The TikaEntityProcessor
 
-After running a full import, the MailEntityProcessor keeps track of the timestamp of the previous import so that subsequent imports can use the fetchMailsSince filter to only pull new messages from the mail server. This occurs automatically using the Data Import Handler dataimport.properties file (stored in conf). For instance, if you set `fetchMailsSince="2014-08-22 00:00:00"` in your `mail-data-config.xml`, then all mail messages that occur after this date will be imported on the first run of the importer. Subsequent imports will use the date of the previous import as the fetchMailsSince filter, so that only new emails since the last import are indexed each time.
+The TikaEntityProcessor uses Apache Tika to process incoming documents. This is similar to <<uploading-data-with-solr-cell-using-apache-tika.adoc#uploading-data-with-solr-cell-using-apache-tika,Uploading Data with Solr Cell using Apache Tika>>, but using DataImportHandler options instead.
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-GMailExtensions]]
-==== GMail Extensions
+The parameters for this processor are described in the table below. These are in addition to the attributes common to all entity processors described above.
 
-When connecting to a GMail account, you can improve the efficiency of the MailEntityProcessor by setting the protocol to *gimap* or *gimaps*. This allows the processor to send the fetchMailsSince filter to the GMail server to have the date filter applied on the server, which means the processor only receives new messages from the server. However, GMail only supports date granularity, so the server-side filter may return previously seen messages if run more than once a day.
+dataSource::
+This parameter defines the data source and an optional name which can be referred to in later parts of the configuration if needed. This is the same `dataSource` explained in the description of general entity processor attributes above.
++
+The available data source types for this processor are:
++
+* BinURLDataSource: used for HTTP resources, but can also be used for files.
+* BinContentStreamDataSource: used for uploading content as a stream.
+* BinFileDataSource: used for content on the local filesystem.
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-TheTikaEntityProcessor]]
-=== The TikaEntityProcessor
+url::
+Required. The path to the source file(s), as a file path or a traditional internet URL.
+
+htmlMapper::
+Optional. Allows control of how Tika parses HTML. If this parameter is defined, it must be either *default* or *identity*; if it is absent, "default" is assumed.
++
+The "default" mapper strips much of the HTML from documents while the "identity" mapper passes all HTML as-is with no modifications.
+
+format::
+The output format. The options are *text*, *xml*, *html* or *none*. The default is "text" if not defined. The format "none" can be used if metadata only should be indexed and not the body of the documents.
+
+parser::
+Optional. The default parser is `org.apache.tika.parser.AutoDetectParser`. If a custom or other parser should be used, it should be entered as a fully-qualified name of the class and path.
+
+fields::
+The list of fields from the input documents and how they should be mapped to Solr fields. If the attribute `meta` is defined as "true", the field will be obtained from the metadata of the document and not parsed from the body of the main text.
+
+extractEmbedded::
+Instructs the TikaEntityProcessor to extract embedded documents or attachments when *true*. If false, embedded documents and attachments will be ignored.
 
-The TikaEntityProcessor uses Apache Tika to process incoming documents. This is similar to <<uploading-data-with-solr-cell-using-apache-tika.adoc#uploading-data-with-solr-cell-using-apache-tika,Uploading Data with Solr Cell using Apache Tika>>, but using the DataImportHandler options instead.
+onError::
+By default, the TikaEntityProcessor will stop processing documents if it finds one that generates an error. If you define `onError` to "skip", the TikaEntityProcessor will instead skip documents that fail processing and log a message that the document was skipped.
 
-Here is an example from the "```tika```" collection of the `dih` example (`example/example-DIH/tika/conf/tika-data-config.xml`):
+Here is an example from the `tika` collection of the `dih` example (data-config file found in `example/example-DIH/tika/conf/tika-data-config.xml`):
 
 [source,xml]
 ----
 <dataConfig>
-  <dataSource type="BinFileDataSource" />
+  <dataSource type="BinFileDataSource"/>
   <document>
-    <entity name="tika-test" processor="TikaEntityProcessor"
-            url="../contrib/extraction/src/test-files/extraction/solr-word.pdf" format="text">
-      <field column="Author" name="author" meta="true"/>
-      <field column="title" name="title" meta="true"/>
-      <field column="text" name="text"/>
+    <entity name="file" processor="FileListEntityProcessor" dataSource="null"
+            baseDir="${solr.install.dir}/example/exampledocs" fileName=".*pdf"
+            rootEntity="false">
+
+      <field column="file" name="id"/>
+
+      <entity name="pdf" processor="TikaEntityProcessor"
+              url="${file.fileAbsolutePath}" format="text">
+
+        <field column="Author" name="author" meta="true"/>
+        <!-- in the original PDF, the Author meta-field name is upper-cased,
+          but in Solr schema it is lower-cased
+         -->
+
+        <field column="title" name="title" meta="true"/>
+        <field column="dc:format" name="format" meta="true"/>
+
+        <field column="text" name="text"/>
+
+      </entity>
     </entity>
   </document>
 </dataConfig>
 ----
 
-The parameters for this processor are described in the table below:
+=== The FileListEntityProcessor
 
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+This processor is basically a wrapper, and is designed to generate a set of files satisfying conditions specified in the attributes which can then be passed to another processor, such as the <<The XPathEntityProcessor,XPathEntityProcessor>>.
 
-[cols="30,70",options="header"]
-|===
-|Attribute |Use
-|dataSource a|
-This parameter defines the data source and an optional name which can be referred to in later parts of the configuration if needed. This is the same dataSource explained in the description of general entity processor attributes above. The available data source types for this processor are:
+The entity information for this processor would be nested within the FileListEntity entry. It generates five implicit fields: `fileAbsolutePath`, `fileDir`, `fileSize`, `fileLastModified`, and `file`, which can be used in the nested processor. This processor does not use a data source.
 
-* BinURLDataSource: used for HTTP resources, but can also be used for files.
-* BinContentStreamDataSource: used for uploading content as a stream.
-* BinFileDataSource: used for content on the local filesystem.
+The attributes specific to this processor are described in the table below:
 
-|url |The path to the source file(s), as a file path or a traditional internet URL. This parameter is required.
-|htmlMapper |Allows control of how Tika parses HTML. The "default" mapper strips much of the HTML from documents while the "identity" mapper passes all HTML as-is with no modifications. If this parameter is defined, it must be either *default* or *identity*; if it is absent, "default" is assumed.
-|format |The output format. The options are *text*, *xml*, *html* or *none*. The default is "text" if not defined. The format "none" can be used if metadata only should be indexed and not the body of the documents.
-|parser |The default parser is `org.apache.tika.parser.AutoDetectParser`. If a custom or other parser should be used, it should be entered as a fully-qualified name of the class and path.
-|fields |The list of fields from the input documents and how they should be mapped to Solr fields. If the attribute `meta` is defined as "true", the field will be obtained from the metadata of the document and not parsed from the body of the main text.
-|extractEmbedded |Instructs the TikaEntityProcessor to extract embedded documents or attachments when *true*. If false, embedded documents and attachments will be ignored.
-|onError |By default, the TikaEntityProcessor will stop processing documents if it finds one that generates an error. If you define `onError` to "skip", the TikaEntityProcessor will instead skip documents that fail processing and log a message that the document was skipped.
-|===
+fileName::
+Required. A regular expression pattern to identify files to be included.
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-TheFileListEntityProcessor]]
-=== The FileListEntityProcessor
+basedir::
+Required. The base directory (absolute path).
 
-This processor is basically a wrapper, and is designed to generate a set of files satisfying conditions specified in the attributes which can then be passed to another processor, such as the <<UploadingStructuredDataStoreDatawiththeDataImportHandler-TheXPathEntityProcessor,XPathEntityProcessor>>. The entity information for this processor would be nested within the FileListEnitity entry. It generates five implicit fields: `fileAbsolutePath, ``fileDir, fileSize, ``fileLastModified, ``file,` which can be used in the nested processor. This processor does not use a data source.
+recursive::
+Whether to search directories recursively. Default is 'false'.
 
-The attributes specific to this processor are described in the table below:
+excludes::
+A regular expression pattern to identify files which will be excluded.
+
+newerThan::
+A date in the format `yyyy-MM-ddHH:mm:ss` or a date math expression (`NOW - 2YEARS`).
 
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-
-[cols="30,70",options="header"]
-|===
-|Attribute |Use
-|fileName |Required. A regular expression pattern to identify files to be included.
-|basedir |Required. The base directory (absolute path).
-|recursive |Whether to search directories recursively. Default is 'false'.
-|excludes |A regular expression pattern to identify files which will be excluded.
-|newerThan |A date in the format `yyyy-MM-ddHH:mm:ss` or a date math expression (`NOW - 2YEARS`).
-|olderThan |A date, using the same formats as newerThan.
-|rootEntity |This should be set to false. This ensures that each row (filepath) emitted by this processor is considered to be a document.
-|dataSource |Must be set to null.
-|===
+olderThan::
+A date, using the same formats as newerThan.
+
+rootEntity::
+This should be set to false. This ensures that each row (filepath) emitted by this processor is considered to be a document.
+
+dataSource::
+Must be set to null.
 
 The example below shows the combination of the FileListEntityProcessor with another processor which will generate a set of fields from each file found.
 
@@ -618,7 +700,7 @@ The example below shows the combination of the FileListEntityProcessor with anot
             dataSource="null"
             baseDir="/my/document/directory">
 
-      <!-- this processor extracts content using Xpath from each file found -->
+      <!-- this processor extracts content using XPath from each file found -->
 
       <entity name="nested" processor="XPathEntityProcessor"
               forEach="/rootelement" url="${f.fileAbsolutePath}" >
@@ -630,22 +712,22 @@ The example below shows the combination of the FileListEntityProcessor with anot
 </dataConfig>
 ----
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-LineEntityProcessor]]
 === LineEntityProcessor
 
 This EntityProcessor reads all content from the data source on a line by line basis and returns a field called `rawLine` for each line read. The content is not parsed in any way; however, you may add transformers to manipulate the data within the `rawLine` field, or to create other additional fields.
 
-The lines read can be filtered by two regular expressions specified with the `acceptLineRegex` and `omitLineRegex` attributes. The table below describes the LineEntityProcessor's attributes:
+The lines read can be filtered by two regular expressions specified with the `acceptLineRegex` and `omitLineRegex` attributes.
+
+The LineEntityProcessor has the following attributes:
+
+url::
+A required attribute that specifies the location of the input file in a way that is compatible with the configured data source. If this value is relative and you are using FileDataSource or URLDataSource, it assumed to be relative to baseLoc.
 
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+acceptLineRegex::
+An optional attribute that if present discards any line which does not match the regular expression.
 
-[cols="30,70",options="header"]
-|===
-|Attribute |Description
-|url |A required attribute that specifies the location of the input file in a way that is compatible with the configured data source. If this value is relative and you are using FileDataSource or URLDataSource, it assumed to be relative to baseLoc.
-|acceptLineRegex |An optional attribute that if present discards any line which does not match the regExp.
-|omitLineRegex |An optional attribute that is applied after any acceptLineRegex and that discards any line which matches this regExp.
-|===
+omitLineRegex::
+An optional attribute that is applied after any `acceptLineRegex` and that discards any line which matches this regular expression.
 
 For example:
 
@@ -659,15 +741,14 @@ For example:
         rootEntity="false"
         dataSource="myURIreader1"
         transformer="RegexTransformer,DateFormatTransformer">
-  ...
+</entity>
 ----
 
-While there are use cases where you might need to create a Solr document for each line read from a file, it is expected that in most cases that the lines read by this processor will consist of a pathname, which in turn will be consumed by another EntityProcessor, such as XPathEntityProcessor.
+While there are use cases where you might need to create a Solr document for each line read from a file, it is expected that in most cases that the lines read by this processor will consist of a pathname, which in turn will be consumed by another entity processor, such as the XPathEntityProcessor.
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-PlainTextEntityProcessor]]
 === PlainTextEntityProcessor
 
-This EntityProcessor reads all content from the data source into an single implicit field called `plainText`. The content is not parsed in any way, however you may add transformers to manipulate the data within the `plainText` as needed, or to create other additional fields.
+This EntityProcessor reads all content from the data source into an single implicit field called `plainText`. The content is not parsed in any way, however you may add <<Transformers,transformers>> to manipulate the data within the `plainText` as needed, or to create other additional fields.
 
 For example:
 
@@ -681,20 +762,56 @@ For example:
 
 Ensure that the dataSource is of type `DataSource<Reader>` (`FileDataSource`, `URLDataSource`).
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-SolrEntityProcessor]]
 === SolrEntityProcessor
 
-Uses Solr instance as a datasource, see https://wiki.apache.org/solr/DataImportHandler#SolrEntityProcessor. In addition to that, SolrEntityProcessor also supports the following parameters:
+This EntityProcessor imports data from different Solr instances and cores. The data is retrieved based on a specified filter query. This EntityProcessor is useful in cases you want to copy your Solr index and want to modify the data in the target index.
+
+The SolrEntityProcessor can only copy fields that are stored in the source index.
+
+The SolrEntityProcessor supports the following parameters:
+
+url::
+Required. The URL of the source Solr instance and/or core.
+
+query::
+Required. The main query to execute on the source index.
+
+fq::
+Any filter queries to execute on the source index. If more than one filter query is defined, they must be separated by a comma.
+
+rows::
+The number of rows to return for each iteration. The default is 50 rows.
+
+fl::
+A comma-separated list of fields to fetch from the source index. Note, these fields must be stored in the source Solr instance.
+
+qt::
+The search handler to use, if not the default.
 
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+wt::
+The response format to use, either *javabin* or *xml*.
 
-[cols="30,70",options="header"]
-|===
-|cursorMark="true" |specify it to enable cursor for efficient result set scrolling
-|sort="id asc" |in this case it usually needs to specify sort param referencing uniqueKey field. see <<pagination-of-results.adoc#pagination-of-results,Pagination of Results>> for details.
-|===
+timeout::
+The query timeout in seconds. The default is 5 minutes (300 seconds).
+
+cursorMark="true"::
+Use this to enable cursor for efficient result set scrolling
+
+sort="id asc"::
+This should be used to specify a sort parameter referencing the uniqueKey field of the source Solr instance. See <<pagination-of-results.adoc#pagination-of-results,Pagination of Results>> for details.
+
+Here is a simple example of a SolrEntityProcessor:
+
+[source,xml]
+<dataConfig>
+  <document>
+    <entity name="sep" processor="SolrEntityProcessor"
+            url="http://127.0.0.1:8983/solr/db "
+            query="*:*"
+            fl="*,orig_version_l:_version_,ignored_price_c:price_c"/>
+  </document>
+</dataConfig>
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-Transformers]]
 == Transformers
 
 Transformers manipulate the fields in a document returned by an entity. A transformer can create new fields or modify existing ones. You must tell the entity which transformers your import operation will be using, by adding an attribute containing a comma separated list to the `<entity>` element.
@@ -706,52 +823,30 @@ Transformers manipulate the fields in a document returned by an entity. A transf
 
 Specific transformation rules are then added to the attributes of a `<field>` element, as shown in the examples below. The transformers are applied in the order in which they are specified in the transformer attribute.
 
-The Data Import Handler contains several built-in transformers. You can also write your own custom transformers, as described in the Solr Wiki (see http://wiki.apache.org/solr/DIHCustomTransformer). The ScriptTransformer (described below) offers an alternative method for writing your own transformers.
+The DataImportHandler contains several built-in transformers. You can also write your own custom transformers, as described in the http://wiki.apache.org/solr/DIHCustomTransformer[DIHCustomTransformer] section of the Solr Wiki. The ScriptTransformer (described below) offers an alternative method for writing your own transformers.
 
-Solr includes the following built-in transformers:
+=== ClobTransformer
 
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+You can use the ClobTransformer to create a string out of a CLOB in a database. A http://en.wikipedia.org/wiki/Character_large_object[CLOB] is a character large object: a collection of character data typically stored in a separate location that is referenced in the database.
 
-[cols="40,60",options="header"]
-|===
-|Transformer Name |Use
-|<<UploadingStructuredDataStoreDatawiththeDataImportHandler-ClobTransformer,ClobTransformer>> |Used to create a String out of a Clob type in database.
-|<<UploadingStructuredDataStoreDatawiththeDataImportHandler-TheDateFormatTransformer,DateFormatTransformer>> |Parse date/time instances.
-|<<UploadingStructuredDataStoreDatawiththeDataImportHandler-TheHTMLStripTransformer,HTMLStripTransformer>> |Strip HTML from a field.
-|<<UploadingStructuredDataStoreDatawiththeDataImportHandler-TheLogTransformer,LogTransformer>> |Used to log data to log files or a console.
-|<<UploadingStructuredDataStoreDatawiththeDataImportHandler-TheNumberFormatTransformer,NumberFormatTransformer>> |Uses the NumberFormat class in java to parse a string into a number.
-|<<UploadingStructuredDataStoreDatawiththeDataImportHandler-TheRegexTransformer,RegexTransformer>> |Use regular expressions to manipulate fields.
-|<<UploadingStructuredDataStoreDatawiththeDataImportHandler-TheScriptTransformer,ScriptTransformer>> |Write transformers in Javascript or any other scripting language supported by Java.
-|<<UploadingStructuredDataStoreDatawiththeDataImportHandler-TheTemplateTransformer,TemplateTransformer>> |Transform a field using a template.
-|===
+The ClobTransformer accepts these attributes:
 
-These transformers are described below.
+clob::
+Boolean value to signal if ClobTransformer should process this field or not. If this attribute is omitted, then the corresponding field is not transformed.
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-ClobTransformer]]
-=== ClobTransformer
+sourceColName::
+The source column to be used as input. If this is absent source and target are same
 
-You can use the ClobTransformer to create a string out of a CLOB in a database. A CLOB is a character large object: a collection of character data typically stored in a separate location that is referenced in the database. See http://en.wikipedia.org/wiki/Character_large_object. Here's an example of invoking the ClobTransformer.
+Here's an example of invoking the ClobTransformer.
 
 [source,xml]
 ----
-<entity name="e" transformer="ClobTransformer" ...>
+<entity name="example" transformer="ClobTransformer" ...>
   <field column="hugeTextField" clob="true" />
   ...
 </entity>
 ----
 
-The ClobTransformer accepts these attributes:
-
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
-
-[cols="30,70",options="header"]
-|===
-|Attribute |Description
-|clob |Boolean value to signal if ClobTransformer should process this field or not. If this attribute is omitted, then the corresponding field is not transformed.
-|sourceColName |The source column to be used as input. If this is absent source and target are same
-|===
-
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-TheDateFormatTransformer]]
 === The DateFormatTransformer
 
 This transformer converts dates from one format to another. This would be useful, for example, in a situation where you wanted to convert a field with a fully specified date/time into a less precise date format, for use in faceting.
@@ -760,15 +855,14 @@ DateFormatTransformer applies only on the fields with an attribute `dateTimeForm
 
 This transformer recognizes the following attributes:
 
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+dateTimeFormat::
+The format used for parsing this field. This must comply with the syntax of the http://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html[Java SimpleDateFormat] class.
+
+sourceColName::
+The column on which the dateFormat is to be applied. If this is absent source and target are same.
 
-[cols="30,70",options="header"]
-|===
-|Attribute |Description
-|dateTimeFormat |The format used for parsing this field. This must comply with the syntax of the http://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html[Java SimpleDateFormat] class.
-|sourceColName |The column on which the dateFormat is to be applied. If this is absent source and target are same.
-|locale |The locale to use for date transformations. If not defined, the ROOT locale is used. It must be specified as language-country (https://tools.ietf.org/html/bcp47[BCP 47 language tag]). For example, `en-US`.
-|===
+locale::
+The locale to use for date transformations. If not defined, the ROOT locale is used. It must be specified as language-country (https://tools.ietf.org/html/bcp47[BCP 47 language tag]). For example, `en-US`.
 
 Here is example code that returns the date rounded up to the month "2007-JUL":
 
@@ -780,10 +874,13 @@ Here is example code that returns the date rounded up to the month "2007-JUL":
 </entity>
 ----
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-TheHTMLStripTransformer]]
 === The HTMLStripTransformer
 
-You can use this transformer to strip HTML out of a field. For example:
+You can use this transformer to strip HTML out of a field.
+
+There is one attribute for this transformer, `stripHTML`, which is a boolean value (true or false) to signal if the HTMLStripTransformer should process the field or not.
+
+For example:
 
 [source,xml]
 ----
@@ -793,9 +890,6 @@ You can use this transformer to strip HTML out of a field. For example:
 </entity>
 ----
 
-There is one attribute for this transformer, `stripHTML`, which is a boolean value (true/false) to signal if the HTMLStripTransformer should process the field or not.
-
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-TheLogTransformer]]
 === The LogTransformer
 
 You can use this transformer to log data to the console or log files. For example:
@@ -811,7 +905,6 @@ You can use this transformer to log data to the console or log files. For exampl
 
 Unlike other transformers, the LogTransformer does not apply to any field, so the attributes are applied on the entity itself.
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-TheNumberFormatTransformer]]
 === The NumberFormatTransformer
 
 Use this transformer to parse a number from a string, converting it into the specified format, and optionally using a different locale.
@@ -820,15 +913,14 @@ NumberFormatTransformer will be applied only to fields with an attribute `format
 
 This transformer recognizes the following attributes:
 
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+formatStyle::
+The format used for parsing this field. The value of the attribute must be one of `number`, `percent`, `integer`, or `currency`. This uses the semantics of the Java NumberFormat class.
+
+sourceColName::
+The column on which the NumberFormat is to be applied. This is attribute is absent. The source column and the target column are the same.
 
-[cols="30,70",options="header"]
-|===
-|Attribute |Description
-|formatStyle |The format used for parsing this field. The value of the attribute must be one of (`number\|percent\|integer\|currency`). This uses the semantics of the Java NumberFormat class.
-|sourceColName |The column on which the NumberFormat is to be applied. This is attribute is absent. The source column and the target column are the same.
-|locale |The locale to be used for parsing the strings. The locale. If not defined, the ROOT locale is used. It must be specified as language-country (https://tools.ietf.org/html/bcp47[BCP 47 language tag]). For example, `en-US`.
-|===
+locale::
+The locale to be used for parsing the strings. The locale. If not defined, the ROOT locale is used. It must be specified as language-country (https://tools.ietf.org/html/bcp47[BCP 47 language tag]). For example, `en-US`.
 
 For example:
 
@@ -843,49 +935,50 @@ For example:
 </entity>
 ----
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-TheRegexTransformer]]
 === The RegexTransformer
 
 The regex transformer helps in extracting or manipulating values from fields (from the source) using Regular Expressions. The actual class name is `org.apache.solr.handler.dataimport.RegexTransformer`. But as it belongs to the default package the package-name can be omitted.
 
 The table below describes the attributes recognized by the regex transformer.
 
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+regex::
+The regular expression that is used to match against the column or sourceColName's value(s). If replaceWith is absent, each regex _group_ is taken as a value and a list of values is returned.
+
+sourceColName::
+The column on which the regex is to be applied. If not present, then the source and target are identical.
+
+splitBy::
+Used to split a string. It returns a list of values. Note, this is a regular expression so it may need to be escaped (e.g., via back-slashes).
 
-[cols="30,70",options="header"]
-|===
-|Attribute |Description
-|regex |The regular expression that is used to match against the column or sourceColName's value(s). If replaceWith is absent, each regex _group_ is taken as a value and a list of values is returned.
-|sourceColName |The column on which the regex is to be applied. If not present, then the source and target are identical.
-|splitBy |Used to split a string. It returns a list of values. note: this is a regular expression – it may need to be escaped (e.g. via back-slashes)
-|groupNames |A comma separated list of field column names, used where the regex contains groups and each group is to be saved to a different field. If some groups are not to be named leave a space between commas.
-|replaceWith |Used along with regex . It is equivalent to the method `new String(<sourceColVal>).replaceAll(<regex>, <replaceWith>)`.
-|===
+groupNames::
+A comma separated list of field column names, used where the regex contains groups and each group is to be saved to a different field. If some groups are not to be named leave a space between commas.
+
+replaceWith::
+Used along with regex . It is equivalent to the method `new String(<sourceColVal>).replaceAll(<regex>, <replaceWith>)`.
 
 Here is an example of configuring the regex transformer:
 
 [source,xml]
 ----
 <entity name="foo" transformer="RegexTransformer"
-        query="select full_name, emailids from foo">
-  <field column="full_name"/>
+        query="select full_name, emailids from foo"> --<1>
+  <field column="full_name"/> --<2>
   <field column="firstName" regex="Mr(\w*)\b.*" sourceColName="full_name"/>
   <field column="lastName" regex="Mr.*?\b(\w*)" sourceColName="full_name"/>
 
   <!-- another way of doing the same -->
 
   <field column="fullName" regex="Mr(\w*)\b(.*)" groupNames="firstName,lastName"/>
-  <field column="mailId" splitBy="," sourceColName="emailids"/>
+  <field column="mailId" splitBy="," sourceColName="emailids"/> --<3>
 </entity>
 ----
 
-In this example, regex and sourceColName are custom attributes used by the transformer. The transformer reads the field `full_name` from the resultset and transforms it to two new target fields, `firstName` and `lastName`. Even though the query returned only one column, `full_name`, in the result set, the Solr document gets two extra fields `firstName` and `lastName` which are "derived" fields. These new fields are only created if the regexp matches.
-
-The emailids field in the table can be a comma-separated value. It ends up producing one or more email IDs, and we expect the `mailId` to be a multivalued field in Solr.
+<1> In this example, `regex` and `sourceColName` are custom attributes used by the transformer.
+<2> The transformer reads the field `full_name` from the result set and transforms it to two new target fields, `firstName` and `lastName`. Even though the query returned only one column, `full_name`, in the result set, the Solr document gets two extra fields `firstName` and `lastName` which are "derived" fields. These new fields are only created if the regexp matches.
+<3> The `emailids` field in the table can be a comma-separated value. It ends up producing one or more email IDs, and we expect the `mailId` to be a multivalued field in Solr.
 
-Note that this transformer can either be used to split a string into tokens based on a splitBy pattern, or to perform a string substitution as per replaceWith, or it can assign groups within a pattern to a list of groupNames. It decides what it is to do based upon the above attributes `splitBy`, `replaceWith` and `groupNames` which are looked for in order. This first one found is acted upon and other unrelated attributes are ignored.
+Note that this transformer can be used to either split a string into tokens based on a splitBy pattern, or to perform a string substitution as per `replaceWith`, or it can assign groups within a pattern to a list of `groupNames`. It decides what it is to do based upon the above attributes `splitBy`, `replaceWith` and `groupNames` which are looked for in order. This first one found is acted upon and other unrelated attributes are ignored.
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-TheScriptTransformer]]
 === The ScriptTransformer
 
 The script transformer allows arbitrary transformer functions to be written in any scripting language supported by Java, such as Javascript, JRuby, Jython, Groovy, or BeanShell. Javascript is integrated into Java 8; you'll need to integrate other languages yourself.
@@ -925,7 +1018,6 @@ Here is a simple example.
 </dataConfig>
 ----
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-TheTemplateTransformer]]
 === The TemplateTransformer
 
 You can use the template transformer to construct or modify a field value, perhaps using the value of other fields. You can insert extra text into the template.
@@ -939,18 +1031,18 @@ You can use the template transformer to construct or modify a field value, perha
 </entity>
 ----
 
-[[UploadingStructuredDataStoreDatawiththeDataImportHandler-SpecialCommandsfortheDataImportHandler]]
-== Special Commands for the Data Import Handler
+== Special Commands for DIH
 
 You can pass special commands to the DIH by adding any of the variables listed below to any row returned by any component:
 
-// TODO: Change column width to %autowidth.spread when https://github.com/asciidoctor/asciidoctor-pdf/issues/599 is fixed
+$skipDoc::
+Skip the current document; that is, do not add it to Solr. The value can be the string `true` or `false`.
+
+$skipRow::
+Skip the current row. The document will be added with rows from other entities. The value can be the string `true` or `false`.
+
+$deleteDocById::
+Delete a document from Solr with this ID. The value has to be the `uniqueKey` value of the document.
 
-[cols="30,70",options="header"]
-|===
-|Variable |Description
-|$skipDoc |Skip the current document; that is, do not add it to Solr. The value can be the string `true\|false`.
-|$skipRow |Skip the current row. The document will be added with rows from other entities. The value can be the string `true\|false`
-|$deleteDocById |Delete a document from Solr with this ID. The value has to be the `uniqueKey` value of the document.
-|$deleteDocByQuery |Delete documents from Solr using this query. The value must be a Solr Query.
-|===
+$deleteDocByQuery::
+Delete documents from Solr using this query. The value must be a Solr Query.


Mime
View raw message