Sqoop 1.4.7 API

Added: sqoop/site/trunk/content/resources/docs/1.4.7/api/index.html URL: http://svn.apache.org/viewvc/sqoop/site/trunk/content/resources/docs/1.4.7/api/index.html?rev=1822913&view=auto ============================================================================== --- sqoop/site/trunk/content/resources/docs/1.4.7/api/index.html (added) +++ sqoop/site/trunk/content/resources/docs/1.4.7/api/index.html Thu Feb 1 23:36:09 2018 @@ -0,0 +1,75 @@ + + + + + +Sqoop 1.4.7 API + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + Added: sqoop/site/trunk/content/resources/docs/1.4.7/api/org/apache/sqoop/lib/BigDecimalSerializer.html URL: http://svn.apache.org/viewvc/sqoop/site/trunk/content/resources/docs/1.4.7/api/org/apache/sqoop/lib/BigDecimalSerializer.html?rev=1822913&view=auto ============================================================================== --- sqoop/site/trunk/content/resources/docs/1.4.7/api/org/apache/sqoop/lib/BigDecimalSerializer.html (added) +++ sqoop/site/trunk/content/resources/docs/1.4.7/api/org/apache/sqoop/lib/BigDecimalSerializer.html Thu Feb 1 23:36:09 2018 @@ -0,0 +1,326 @@ + + + + + +BigDecimalSerializer (Sqoop 1.4.7 API) + + + + + + + + +

Skip navigation links

+ + + +

+

+

+

Prev Class
Next Class

+

Frames
No Frames

+

All Classes

+

+ +

+

+

Summary:
Nested |
Field |
Constr |
Method

+

Detail:
Field |
Constr |
Method

+

+ + + +

+

java.lang.Object
+
- org.apache.sqoop.lib.BigDecimalSerializer
+

+

+

+
+
+
```
public final class BigDecimalSerializer
+extends java.lang.Object
```
+
Serialize BigDecimal classes to/from DataInput and DataOutput objects. + + BigDecimal is comprised of a BigInteger with an integer 'scale' field. + The BigDecimal/BigInteger can also return itself as a 'long' value. + + We serialize in one of two formats: + + First, check whether the BigInt can fit in a long: + boolean b = BigIntegerPart > LONG_MAX || BigIntegerPart < LONG_MIN + + [int: scale][boolean: b == false][long: BigInt-part] + [int: scale][boolean: b == true][string: BigInt-part.toString()] + + TODO(aaron): Get this to work with Hadoop's Serializations framework.
+

+

+

+

+ +

+ + +
Field Summary
+ + + + + + + + + + + + + + +
Fields
Modifier and Type Field and Description
static java.math.BigInteger LONG_MAX_AS_BIGINT
static java.math.BigInteger LONG_MIN_AS_BIGINT
+

+ +

Method Summary

+ + + + + + + + + + + + + + +

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.math.BigDecimal`	`readFields(java.io.DataInput in)`
`static void`	`write(java.math.BigDecimal d, + java.io.DataOutput out)`

+

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+

+

+

+

+

+ +

Field Detail

+ + + +

+

LONG_MAX_AS_BIGINT

+

public static final java.math.BigInteger LONG_MAX_AS_BIGINT

+

+ + + +

+

LONG_MIN_AS_BIGINT

+

public static final java.math.BigInteger LONG_MIN_AS_BIGINT

+

+

+ +

Method Detail

+ + + +

+

write

+

public static void write(java.math.BigDecimal d,
+                         java.io.DataOutput out)
+                  throws java.io.IOException

+

Throws:: java.io.IOException

+

+ + + +

+

readFields

+

public static java.math.BigDecimal readFields(java.io.DataInput in)
+                                       throws java.io.IOException

+

Throws:: java.io.IOException

+

+

+

+

+

+ + +

Skip navigation links

+ + + +

+

+

+

Prev Class
Next Class

+

Frames
No Frames

+

All Classes

+

+ +

+

+

Summary:
Nested |
Field |
Constr |
Method

+

Detail:
Field |
Constr |
Method

+

+ +

Copyright © 2017 The Apache Software Foundation

+ + Added: sqoop/site/trunk/content/resources/docs/1.4.7/api/org/apache/sqoop/lib/BlobRef.html URL: http://svn.apache.org/viewvc/sqoop/site/trunk/content/resources/docs/1.4.7/api/org/apache/sqoop/lib/BlobRef.html?rev=1822913&view=auto ============================================================================== --- sqoop/site/trunk/content/resources/docs/1.4.7/api/org/apache/sqoop/lib/BlobRef.html (added) +++ sqoop/site/trunk/content/resources/docs/1.4.7/api/org/apache/sqoop/lib/BlobRef.html Thu Feb 1 23:36:09 2018 @@ -0,0 +1,531 @@ + + + + + +BlobRef (Sqoop 1.4.7 API) + + + + + + + + +

Skip navigation links

+ + + +

+

+

+

Prev Class
Next Class

+

Frames
No Frames

+

All Classes

+

+ +

+

+

Summary:
Nested |
Field |
Constr |
Method

+

Detail:
Field |
Constr |
Method

+

+ + + +

+

java.lang.Object
+
- org.apache.sqoop.lib.LobRef<DATATYPE,CONTAINERTYPE,ACCESSORTYPE>
- +
  - com.cloudera.sqoop.lib.LobRef<byte[],org.apache.hadoop.io.BytesWritable,java.io.InputStream>
  - +
    - org.apache.sqoop.lib.BlobRef
    +
  +
+

+

+

+
+
All Implemented Interfaces:
+
java.io.Closeable, java.lang.AutoCloseable, org.apache.hadoop.io.Writable
+
+
+
Direct Known Subclasses:
+
BlobRef
+
+
+
+
```
public class BlobRef
+extends LobRef<byte[],org.apache.hadoop.io.BytesWritable,java.io.InputStream>
```
+
BlobRef is a wrapper that holds a BLOB either directly, or a + reference to a file that holds the BLOB data.
+

+

+

+

+ +

+ + +
Field Summary
+ + + + + + + + + + +
Fields
Modifier and Type Field and Description
static org.apache.commons.logging.Log LOG
+
- + + +
  Fields inherited from class com.cloudera.sqoop.lib.LobRef
  +EXTERNAL_MATCHER
+

+ +

+ + +
Constructor Summary
+ + + + + + + + + + + + + + +
Constructors
Constructor and Description
BlobRef()
BlobRef(byte[] bytes)
BlobRef(java.lang.String file, + long offset, + long length) +
Initialize a BlobRef to an external BLOB.
+
+

+ +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected org.apache.hadoop.io.BytesWritable`	`deepCopyData(org.apache.hadoop.io.BytesWritable data)` + Make a copy of the materialized data. +
`protected java.io.InputStream`	`getExternalSource(com.cloudera.sqoop.io.LobFile.Reader reader)` + Using the LobFile reader, get an accessor InputStream or Reader to the + underlying data. +
`protected byte[]`	`getInternalData(org.apache.hadoop.io.BytesWritable data)`
`protected java.io.InputStream`	`getInternalSource(org.apache.hadoop.io.BytesWritable data)` + Wrap the materialized data in an InputStream or Reader. +
`static BlobRef`	`parse(java.lang.String inputString)` + Create a BlobRef based on parsed data from a line of text. +
`void`	`readFieldsInternal(java.io.DataInput in)` + Perform the readFields() operation on a fully-materializable record. +
`void`	`writeInternal(java.io.DataOutput out)` + Perform the write() operation on a fully-materializable record. +

+

+ + +
Methods inherited from class org.apache.sqoop.lib.LobRef
+clone, close, finalize, getData, getDataObj, getDataStream, getDataStream, isExternal, readFields, setDataObj, toString, write

+

+ + +
Methods inherited from class java.lang.Object
+equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

+

+

+

+

+

+ +
- + + +
  Field Detail
  + + + +
  - +
    LOG
    +
```
public static final org.apache.commons.logging.Log LOG
```
    +
  +
+ +
- + + +
  Constructor Detail
  + + + +
  - +
    BlobRef
    +
```
public BlobRef()
```
    +
  + + + +
  - +
    BlobRef
    +
```
public BlobRef(byte[] bytes)
```
    +
  + + + +
  - +
    BlobRef
    +
```
public BlobRef(java.lang.String file,
+               long offset,
+               long length)
```
    +
    Initialize a BlobRef to an external BLOB.
    +
    +
    Parameters:
    +
    file - the filename to the BLOB. May be relative to the job dir.
    +
    offset - the offset (in bytes) into the LobFile for this record.
    +
    length - the length of the record in bytes.
    +
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    getExternalSource
    +
```
protected java.io.InputStream getExternalSource(com.cloudera.sqoop.io.LobFile.Reader reader)
+                                         throws java.io.IOException
```
    +
    Description copied from class: LobRef
    +
    Using the LobFile reader, get an accessor InputStream or Reader to the + underlying data.
    +
    +
    Specified by:
    +
    getExternalSource in class LobRef<byte[],org.apache.hadoop.io.BytesWritable,java.io.InputStream>
    +
    Throws:
    +
    java.io.IOException
    +
    +
  + + + +
  - +
    getInternalSource
    +
```
protected java.io.InputStream getInternalSource(org.apache.hadoop.io.BytesWritable data)
```
    +
    Description copied from class: LobRef
    +
    Wrap the materialized data in an InputStream or Reader.
    +
    +
    Specified by:
    +
    getInternalSource in class LobRef<byte[],org.apache.hadoop.io.BytesWritable,java.io.InputStream>
    +
    +
  + + + +
  - +
    getInternalData
    +
```
protected byte[] getInternalData(org.apache.hadoop.io.BytesWritable data)
```
    +
    +
    Specified by:
    +
    getInternalData in class LobRef<byte[],org.apache.hadoop.io.BytesWritable,java.io.InputStream>
    +
    Returns:
    +
    the materialized data itself.
    +
    +
  + + + +
  - +
    deepCopyData
    +
```
protected org.apache.hadoop.io.BytesWritable deepCopyData(org.apache.hadoop.io.BytesWritable data)
```
    +
    Description copied from class: LobRef
    +
    Make a copy of the materialized data.
    +
    +
    Specified by:
    +
    deepCopyData in class LobRef<byte[],org.apache.hadoop.io.BytesWritable,java.io.InputStream>
    +
    +
  + + + +
  - +
    readFieldsInternal
    +
```
public void readFieldsInternal(java.io.DataInput in)
+                        throws java.io.IOException
```
    +
    Description copied from class: LobRef
    +
    Perform the readFields() operation on a fully-materializable record.
    +
    +
    Specified by:
    +
    readFieldsInternal in class LobRef<byte[],org.apache.hadoop.io.BytesWritable,java.io.InputStream>
    +
    Parameters:
    +
    in - the DataInput to deserialize from.
    +
    Throws:
    +
    java.io.IOException
    +
    +
  + + + +
  - +
    writeInternal
    +
```
public void writeInternal(java.io.DataOutput out)
+                   throws java.io.IOException
```
    +
    Description copied from class: LobRef
    +
    Perform the write() operation on a fully-materializable record.
    +
    +
    Specified by:
    +
    writeInternal in class LobRef<byte[],org.apache.hadoop.io.BytesWritable,java.io.InputStream>
    +
    Parameters:
    +
    out - the DataOutput to deserialize to.
    +
    Throws:
    +
    java.io.IOException
    +
    +
  + + + +
  - +
    parse
    +
```
public static BlobRef parse(java.lang.String inputString)
```
    +
    Create a BlobRef based on parsed data from a line of text. + This only operates correctly on external blobs; inline blobs are simply + returned as null. You should store BLOB data in SequenceFile format + if reparsing is necessary.
    +
    +
    Parameters:
    +
    inputString - the text-based input data to parse.
    +
    Returns:
    +
    a new BlobRef containing a reference to an external BLOB, or + an empty BlobRef if the data to be parsed is actually inline.
    +
    +
  +
+

+

+

+ + +

Skip navigation links

+ + + +

+

+

+

Prev Class
Next Class

+

Frames
No Frames

+

All Classes

+

+ +

+

+

Summary:
Nested |
Field |
Constr |
Method

+

Detail:
Field |
Constr |
Method

+

+ +

Copyright © 2017 The Apache Software Foundation

+ + Added: sqoop/site/trunk/content/resources/docs/1.4.7/api/org/apache/sqoop/lib/BooleanParser.html URL: http://svn.apache.org/viewvc/sqoop/site/trunk/content/resources/docs/1.4.7/api/org/apache/sqoop/lib/BooleanParser.html?rev=1822913&view=auto ============================================================================== --- sqoop/site/trunk/content/resources/docs/1.4.7/api/org/apache/sqoop/lib/BooleanParser.html (added) +++ sqoop/site/trunk/content/resources/docs/1.4.7/api/org/apache/sqoop/lib/BooleanParser.html Thu Feb 1 23:36:09 2018 @@ -0,0 +1,248 @@ + + + + + +BooleanParser (Sqoop 1.4.7 API) + + + + + + + + +

Skip navigation links

+ + + +

+

+

+

Prev Class
Next Class

+

Frames
No Frames

+

All Classes

+

+ +

+

+

Summary:
Nested |
Field |
Constr |
Method

+

Detail:
Field |
Constr |
Method

+

+ + + +

+

java.lang.Object
+
- org.apache.sqoop.lib.BooleanParser
+

+

+

+
+
+
```
public final class BooleanParser
+extends java.lang.Object
```
+
Parse string representations of boolean values into boolean + scalar types.
+

+

+

+

+ +
- + + +
  Method Summary
  + + + + + + + + + + +
  All Methods Static Methods Concrete Methods
  Modifier and Type Method and Description
  static boolean valueOf(java.lang.String s) +
  Return a boolean based on the value contained in the string.
  +
  +
  - + + +
    Methods inherited from class java.lang.Object
    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  +
+

+

+

+

+ +
- + + +
  Method Detail
  + + + +
  - +
    valueOf
    +
```
public static boolean valueOf(java.lang.String s)
```
    +
    Return a boolean based on the value contained in the string. + +
    The following values are considered true: + "true", "t", "yes", "on", "1".
    +
    All other values, including 'null', are false.
    +
    All comparisons are case-insensitive.
    +
  +
+

+

+

+ + +

Skip navigation links

+ + + +

+

+

+

Prev Class
Next Class

+

Frames
No Frames

+

All Classes

+

+ +

+

+

Summary:
Nested |
Field |
Constr |
Method

+

Detail:
Field |
Constr |
Method

+

+ +

Copyright © 2017 The Apache Software Foundation

+ + Added: sqoop/site/trunk/content/resources/docs/1.4.7/api/org/apache/sqoop/lib/ClobRef.html URL: http://svn.apache.org/viewvc/sqoop/site/trunk/content/resources/docs/1.4.7/api/org/apache/sqoop/lib/ClobRef.html?rev=1822913&view=auto ============================================================================== --- sqoop/site/trunk/content/resources/docs/1.4.7/api/org/apache/sqoop/lib/ClobRef.html (added) +++ sqoop/site/trunk/content/resources/docs/1.4.7/api/org/apache/sqoop/lib/ClobRef.html Thu Feb 1 23:36:09 2018 @@ -0,0 +1,499 @@ + + + + + +ClobRef (Sqoop 1.4.7 API) + + + + + + + + +

Skip navigation links

+ + + +

+

+

+

Prev Class
Next Class

+

Frames
No Frames

+

All Classes

+

+ +

+

+

Summary:
Nested |
Field |
Constr |
Method

+

Detail:
Field |
Constr |
Method

+

+ + + +

+

java.lang.Object
+
- org.apache.sqoop.lib.LobRef<DATATYPE,CONTAINERTYPE,ACCESSORTYPE>
- +
  - com.cloudera.sqoop.lib.LobRef<java.lang.String,java.lang.String,java.io.Reader>
  - +
    - org.apache.sqoop.lib.ClobRef
    +
  +
+

+

+

+
+
All Implemented Interfaces:
+
java.io.Closeable, java.lang.AutoCloseable, org.apache.hadoop.io.Writable
+
+
+
Direct Known Subclasses:
+
ClobRef
+
+
+
+
```
public class ClobRef
+extends LobRef<java.lang.String,java.lang.String,java.io.Reader>
```
+
ClobRef is a wrapper that holds a CLOB either directly, or a + reference to a file that holds the CLOB data.
+

+

+

+

+ +

+ + +
Field Summary
+
- + + +
  Fields inherited from class com.cloudera.sqoop.lib.LobRef
  +EXTERNAL_MATCHER, LOG
+

+ +

Constructor Summary

+ + + + + + + + + + + + + + +

Constructors
Constructor and Description
`ClobRef()`
`ClobRef(java.lang.String chars)`
`ClobRef(java.lang.String file, + long offset, + long length)` + Initialize a clobref to an external CLOB. +

+

+ +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.lang.String`	`deepCopyData(java.lang.String data)` + Make a copy of the materialized data. +
`protected java.io.Reader`	`getExternalSource(com.cloudera.sqoop.io.LobFile.Reader reader)` + Using the LobFile reader, get an accessor InputStream or Reader to the + underlying data. +
`protected java.lang.String`	`getInternalData(java.lang.String data)`
`protected java.io.Reader`	`getInternalSource(java.lang.String data)` + Wrap the materialized data in an InputStream or Reader. +
`static ClobRef`	`parse(java.lang.String inputString)` + Create a ClobRef based on parsed data from a line of text. +
`void`	`readFieldsInternal(java.io.DataInput in)` + Perform the readFields() operation on a fully-materializable record. +
`void`	`writeInternal(java.io.DataOutput out)` + Perform the write() operation on a fully-materializable record. +

+

+ + +
Methods inherited from class org.apache.sqoop.lib.LobRef
+clone, close, finalize, getData, getDataObj, getDataStream, getDataStream, isExternal, readFields, setDataObj, toString, write

+

+ + +
Methods inherited from class java.lang.Object
+equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

+

+

+

+

+

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    ClobRef
    +
```
public ClobRef()
```
    +
  + + + +
  - +
    ClobRef
    +
```
public ClobRef(java.lang.String chars)
```
    +
  + + + +
  - +
    ClobRef
    +
```
public ClobRef(java.lang.String file,
+               long offset,
+               long length)
```
    +
    Initialize a clobref to an external CLOB.
    +
    +
    Parameters:
    +
    file - the filename to the CLOB. May be relative to the job dir.
    +
    offset - the offset (in bytes) into the LobFile for this record.
    +
    length - the length of the record in characters.
    +
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    getExternalSource
    +
```
protected java.io.Reader getExternalSource(com.cloudera.sqoop.io.LobFile.Reader reader)
+                                    throws java.io.IOException
```
    +
    Description copied from class: LobRef
    +
    Using the LobFile reader, get an accessor InputStream or Reader to the + underlying data.
    +
    +
    Specified by:
    +
    getExternalSource in class LobRef<java.lang.String,java.lang.String,java.io.Reader>
    +
    Throws:
    +
    java.io.IOException
    +
    +
  + + + +
  - +
    getInternalSource
    +
```
protected java.io.Reader getInternalSource(java.lang.String data)
```
    +
    Description copied from class: LobRef
    +
    Wrap the materialized data in an InputStream or Reader.
    +
    +
    Specified by:
    +
    getInternalSource in class LobRef<java.lang.String,java.lang.String,java.io.Reader>
    +
    +
  + + + +
  - +
    deepCopyData
    +
```
protected java.lang.String deepCopyData(java.lang.String data)
```
    +
    Description copied from class: LobRef
    +
    Make a copy of the materialized data.
    +
    +
    Specified by:
    +
    deepCopyData in class LobRef<java.lang.String,java.lang.String,java.io.Reader>
    +
    +
  + + + +
  - +
    getInternalData
    +
```
protected java.lang.String getInternalData(java.lang.String data)
```
    +
    +
    Specified by:
    +
    getInternalData in class LobRef<java.lang.String,java.lang.String,java.io.Reader>
    +
    Returns:
    +
    the materialized data itself.
    +
    +
  + + + +
  - +
    readFieldsInternal
    +
```
public void readFieldsInternal(java.io.DataInput in)
+                        throws java.io.IOException
```
    +
    Description copied from class: LobRef
    +
    Perform the readFields() operation on a fully-materializable record.
    +
    +
    Specified by:
    +
    readFieldsInternal in class LobRef<java.lang.String,java.lang.String,java.io.Reader>
    +
    Parameters:
    +
    in - the DataInput to deserialize from.
    +
    Throws:
    +
    java.io.IOException
    +
    +
  + + + +
  - +
    writeInternal
    +
```
public void writeInternal(java.io.DataOutput out)
+                   throws java.io.IOException
```
    +
    Description copied from class: LobRef
    +
    Perform the write() operation on a fully-materializable record.
    +
    +
    Specified by:
    +
    writeInternal in class LobRef<java.lang.String,java.lang.String,java.io.Reader>
    +
    Parameters:
    +
    out - the DataOutput to deserialize to.
    +
    Throws:
    +
    java.io.IOException
    +
    +
  + + + +
  - +
    parse
    +
```
public static ClobRef parse(java.lang.String inputString)
```
    +
    Create a ClobRef based on parsed data from a line of text.
    +
    +
    Parameters:
    +
    inputString - the text-based input data to parse.
    +
    Returns:
    +
    a ClobRef to the given data.
    +
    +
  +
+

+

+

+ + +

Skip navigation links

+ + + +

+

+

+

Prev Class
Next Class

+

Frames
No Frames

+

All Classes

+

+ +

+

+

Summary:
Nested |
Field |
Constr |
Method

+

Detail:
Field |
Constr |
Method

+

+ +

Copyright © 2017 The Apache Software Foundation

+ +