doc: documented configuration options for incremental data loading

Author: fransflippo

docs/index.asciidoc

@@ -41,7 +41,7 @@ that will be used in the SOQL query.
 
 ==== HTTP proxy
 
-If your infrastructure uses a HTTP proxy, you can set the `SALESFORCE_PROXY_URI` environment variable with the desired URI value (e.g `export SALESFORCE_PROXY_URI="http://proxy.example.com:123"`).
+If your infrastructure uses an HTTP proxy, you can set the `SALESFORCE_PROXY_URI` environment variable with the desired URI value (e.g `export SALESFORCE_PROXY_URI="http://proxy.example.com:123"`).
 
 ==== Example
 This example prints all the Salesforce Opportunities to standard out
@@ -79,6 +79,9 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-client_secret>> |<<password,password>>|Yes
 | <<plugins-{type}s-{plugin}-interval>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-password>> |<<password,password>>|Yes
+| <<plugins-{type}s-{plugin}-range_field>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-range_filter>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-range_field_value_file>> |<<string,string>>|No
 | <<plugins-{type}s-{plugin}-security_token>> |<<password,password>>|Yes
 | <<plugins-{type}s-{plugin}-sfdc_fields>> |<<array,array>>|No
 | <<plugins-{type}s-{plugin}-sfdc_filters>> |<<string,string>>|No
@@ -103,7 +106,7 @@ input plugins.
   * There is no default value for this setting.
 
 By default, this uses the default Restforce API version.
-To override this, set this to something like "32.0" for example
+To override this, set this to something like "32.0" for example.
 
 [id="plugins-{type}s-{plugin}-client_id"]
 ===== `client_id` 
@@ -112,10 +115,10 @@ To override this, set this to something like "32.0" for example
   * Value type is <<string,string>>
   * There is no default value for this setting.
 
-Consumer Key for authentication. You must set up a new SFDC
-connected app with oath to use this output. More information
+Consumer Key for authentication. You must set up a new Salesforce
+connected app with OAuth enabled to use this plugin. More information
 can be found here:
-https://help.salesforce.com/apex/HTViewHelpDoc?id=connected_app_create.htm
+https://help.salesforce.com/apex/HTViewHelpDoc?id=connected_app_create.htm.
 
 [id="plugins-{type}s-{plugin}-client_secret"]
 ===== `client_secret` 
@@ -124,7 +127,7 @@ https://help.salesforce.com/apex/HTViewHelpDoc?id=connected_app_create.htm
   * Value type is <<password,password>>
   * There is no default value for this setting.
 
-Consumer Secret from your oauth enabled connected app
+Consumer secret from your OAuth enabled connected app.
 
 [id="plugins-{type}s-{plugin}-interval"]
 ===== `interval`
@@ -150,21 +153,95 @@ If this property is not specified or is set to -1, the plugin will run once and
   * Value type is <<password,password>>
   * There is no default value for this setting.
 
-The password used to login to sfdc
+The password used to log in to Salesforce.
 
-[id="plugins-{type}s-{plugin}-security_token"]
-===== `security_token` 
+[id="plugins-{type}s-{plugin}-range_field"]
+===== `range_field`
 
-  * This is a required setting.
-  * Value type is <<password,password>>
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The field to track for incremental data loads. This field will
+be used in an `ORDER BY ... ASC` clause that is added to the Salesforce query.
+This field _should_ also be used in the <<plugins-{type}s-{plugin}-range_filter>> clause
+to actually achieve incremental loading of data.
+
+The last value (which is the highest value if the query sorts by this field ascending)
+value for this field will be saved to the file at the path configured by
+<<plugins-{type}s-{plugin}-range_field_value_file>>, if specified.
+
+This field should ideally be strictly ascending for new records. An
+autonumber field is ideal for this.
+
+The standard `LastModifiedDate` field can be used, but since it is not _strictly_
+ascending (multiple records can have the same `LastModifiedDate`, the
+<<plugins-{type}s-{plugin}-range_filter>> should account for this by using the `>=`
+operator, and duplicates should be expected.
+
+Note that Salesforce does not guarantee that the standard `Id` field has ascending
+values for new records (https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_testing_best_practices.htm).
+Therefore, using `Id` as range field risks missing records and is not recommended.
+
+If this field is not already included in the <<plugins-{type}s-{plugin}-sfdc_fields>>,
+it is added.
+
+[id="plugins-{type}s-{plugin}-range_field_value_file"]
+===== `range_field_value_file`
+
+* Value type is <<string,string>>
+* There is no default value for this setting.
+
+The full path to the file from which the latest range field value from the previous
+plugin invocation will be read, and to which the new latest range field value will be
+written after the current plugin invocation.
+
+This keeps persistent track of the last seen value of the range field used for incremental
+loading of data.
+
+The file should be readable and writable by the Logstash process.
+
+If the file exists and a <<plugins-{type}s-{plugin}-range_filter>> is configured,
+a range filter clause is added to the query (and combined with any <<plugins-{type}s-{plugin}-sfdc_filters>>
+clause that is configured using the `AND` operator).
+
+If the result set is not empty, the value for `range_field` from the last row is
+written to the file.
+
+[id="plugins-{type}s-{plugin}-range_filter"]
+===== `range_filter`
+
+* Value type is <<string,string>>
   * There is no default value for this setting.
 
+The filter to add to the Salesforce query when a previous range field value
+was read from the <<plugins-{type}s-{plugin}-range_field_value_file>>.
+The string can (and should) contain a placeholder `%+{range_field_value}+` that
+will be substituted with the actual value read from the <<plugins-{type}s-{plugin}-range_field_value_file>>.
+
+This clause is combined with any <<plugins-{type}s-{plugin}-sfdc_filters>>
+clause that is configured using the `AND` operator.
+
+The value should be properly quoted according to the SOQL rules for the field
+type.
+
+**Examples:**
+
+  "range_filter" => "Number > '%{range_field_value}'"
+  "range_filter" => "LastModifiedDate >= %{range_field_value}"
+
+[id="plugins-{type}s-{plugin}-security_token"]
+===== `security_token`
+
+* This is a required setting.
+* Value type is <<password,password>>
+* There is no default value for this setting.
+
 The security token for this account. For more information about
-generting a security token, see:
-https://help.salesforce.com/apex/HTViewHelpDoc?id=user_security_token.htm
+generating a security token, see:
+https://help.salesforce.com/apex/HTViewHelpDoc?id=user_security_token.htm.
 
 [id="plugins-{type}s-{plugin}-sfdc_fields"]
-===== `sfdc_fields` 
+===== `sfdc_fields`
 
   * Value type is <<array,array>>
   * Default value is `[]`
@@ -178,9 +255,9 @@ If this is empty, all fields are returned.
   * Value type is <<string,string>>
   * Default value is `""`
 
-These options will be added to the WHERE clause in the
+These options will be added to the `WHERE` clause in the
 SOQL statement. Additional fields can be filtered on by
-adding field1 = value1 AND field2 = value2 AND...
+adding `field1 = value1 AND field2 = value2 AND...`.
 
 [id="plugins-{type}s-{plugin}-sfdc_instance_url"]
 ===== `sfdc_instance_url`
@@ -202,7 +279,7 @@ but not both to configure the url to which the plugin connects to.
   * Value type is <<string,string>>
   * There is no default value for this setting.
 
-The name of the salesforce object you are creating or updating
+The name of the Salesforce object you are creating or updating.
 
 [id="plugins-{type}s-{plugin}-timeout"]
 ===== `timeout`
@@ -221,7 +298,7 @@ read, an error occurs.
   * Value type is <<boolean,boolean>>
   * Default value is `false`
 
-Setting this to true will convert SFDC's NamedFields__c to named_fields__c
+Setting this to true will convert Salesforce's `++NamedFields__c++` to `++named_fields__c++`.
 
 [id="plugins-{type}s-{plugin}-use_test_sandbox"]
 ===== `use_test_sandbox` 
@@ -230,7 +307,7 @@ Setting this to true will convert SFDC's NamedFields__c to named_fields__c
   * Default value is `false`
 
 Set this to true to connect to a sandbox sfdc instance
-logging in through test.salesforce.com
+logging in through test.salesforce.com.
 
 Use either this or the `sfdc_instance_url` configuration option
 but not both to configure the url to which the plugin connects to.
@@ -255,9 +332,9 @@ of elements of sfdc flows) and security health check risks.
   * Value type is <<string,string>>
   * There is no default value for this setting.
 
-A valid salesforce user name, usually your email address.
+A valid Salesforce username, usually your email address.
 Used for authentication and will be the user all objects
-are created or modified by
+are created or modified by.