You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sqoop.apache.org by ab...@apache.org on 2015/02/05 23:04:51 UTC
sqoop git commit: SQOOP-2074: Sqoop2: Add input attributes
documentation
Repository: sqoop
Updated Branches:
refs/heads/sqoop2 d3062f340 -> 7fff9ae90
SQOOP-2074: Sqoop2: Add 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/7fff9ae9
Tree: http://git-wip-us.apache.org/repos/asf/sqoop/tree/7fff9ae9
Diff: http://git-wip-us.apache.org/repos/asf/sqoop/diff/7fff9ae9
Branch: refs/heads/sqoop2
Commit: 7fff9ae9091644a537ce228068059d0a2f403924
Parents: d3062f3
Author: Abraham Elmahrek <ab...@apache.org>
Authored: Thu Feb 5 13:54:54 2015 -0800
Committer: Abraham Elmahrek <ab...@apache.org>
Committed: Thu Feb 5 13:54:54 2015 -0800
----------------------------------------------------------------------
docs/src/site/sphinx/ConnectorDevelopment.rst | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/sqoop/blob/7fff9ae9/docs/src/site/sphinx/ConnectorDevelopment.rst
----------------------------------------------------------------------
diff --git a/docs/src/site/sphinx/ConnectorDevelopment.rst b/docs/src/site/sphinx/ConnectorDevelopment.rst
index 16b0ecf..2526ca2 100644
--- a/docs/src/site/sphinx/ConnectorDevelopment.rst
+++ b/docs/src/site/sphinx/ConnectorDevelopment.rst
@@ -385,6 +385,26 @@ 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
+that describe how the input will be used in the sqoop job. Here are the list of the supported attributes
+
+
+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 |
++-----------------------------+---------+-----------------------------------------------------------------------+-------------------------------------------------+
+| 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 |
++-----------------------------+---------+-----------------------------------------------------------------------+-------------------------------------------------+
+| overrides | String |Describes a list of other inputs this input can override in this config|@Input(overrides ="value") public String lvalue |
++-----------------------------+---------+-----------------------------------------------------------------------+-------------------------------------------------+
+
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.