Repository: sqoop Updated Branches: refs/heads/sqoop2 922e1e672 -> d3efcd22a
SQOOP-2084: Sqoop2: Fix Indentation in input attributes documentation (Veena Basavaraj via Abraham Elmahrek) Project: http://git-wip-us.apache.org/repos/asf/sqoop/repo Commit: http://git-wip-us.apache.org/repos/asf/sqoop/commit/d3efcd22 Tree: http://git-wip-us.apache.org/repos/asf/sqoop/tree/d3efcd22 Diff: http://git-wip-us.apache.org/repos/asf/sqoop/diff/d3efcd22 Branch: refs/heads/sqoop2 Commit: d3efcd22a097c16d913b046a2762a586983719e2 Parents: 922e1e6 Author: Abraham Elmahrek <[email protected]> Authored: Thu Feb 5 15:25:39 2015 -0800 Committer: Abraham Elmahrek <[email protected]> Committed: Thu Feb 5 15:25:39 2015 -0800 ---------------------------------------------------------------------- docs/src/site/sphinx/ConnectorDevelopment.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/sqoop/blob/d3efcd22/docs/src/site/sphinx/ConnectorDevelopment.rst ---------------------------------------------------------------------- diff --git a/docs/src/site/sphinx/ConnectorDevelopment.rst b/docs/src/site/sphinx/ConnectorDevelopment.rst index 2526ca2..2d9e7d2 100644 --- a/docs/src/site/sphinx/ConnectorDevelopment.rst +++ b/docs/src/site/sphinx/ConnectorDevelopment.rst @@ -385,6 +385,7 @@ Each ``ConfigClass`` defines the different inputs it exposes for the link and jo Each ``ConfigClass`` and the inputs within the configs annotated with ``Input`` can specifiy validators via the ``@Validator`` annotation described below. + Configs and Inputs ================================== As discussed above, ``Input`` provides a way to express the type of config parameter exposed. In addition it allows connector developer to add attributes @@ -396,15 +397,21 @@ Inputs associated with the link configuration include: +-----------------------------+---------+-----------------------------------------------------------------------+-------------------------------------------------+ | Attribute | Type | Description | Example | +=============================+=========+=======================================================================+=================================================+ -| size | Integer| Describes the maximum size of the attribute value . |@Input(size = 128) public String driver | +| size | Integer |Describes the maximum size of the attribute value . |@Input(size = 128) public String driver | +-----------------------------+---------+-----------------------------------------------------------------------+-------------------------------------------------+ | sensitive | Boolean |Describes if the input value should be hidden from display |@Input(sensitive = true) public String password | +-----------------------------+---------+-----------------------------------------------------------------------+-------------------------------------------------+ -| editable | Enum |Describes the roles that can edit the value of this input |@Input(editable =USER_ONLY) public String value | +| editable | Enum |Describes the roles that can edit the value of this input |@Input(editable = ANY) public String value | +-----------------------------+---------+-----------------------------------------------------------------------+-------------------------------------------------+ | overrides | String |Describes a list of other inputs this input can override in this config|@Input(overrides ="value") public String lvalue | +-----------------------------+---------+-----------------------------------------------------------------------+-------------------------------------------------+ + +``Editable`` Attribute: Possible values for the Enum InputEditable are USER_ONLY, CONNECTOR_ONLY, ANY. If an input says editable by USER_ONLY, then the connector code during the +job run or upgrade cannot update the config input value. Similarly for a CONNECTOR_ONLY, user cannot update its value via the rest api or shell command line. + +``Overrides`` Attribute: USER_ONLY input attribute values cannot be overriden by other inputs. + Empty Configuration ------------------- If a connector does not have any configuration inputs to specify for the ``ConfigType.LINK`` or ``ConfigType.JOB`` it is recommended to return the ``EmptyConfiguration`` class in the ``getLinkConfigurationClass()`` or ``getJobConfigurationClass(..)`` methods.
