diff --git a/docs/assets/javadoc/allclasses-index.html b/docs/assets/javadoc/allclasses-index.html index c3a8f9ca..361bc9ae 100644 --- a/docs/assets/javadoc/allclasses-index.html +++ b/docs/assets/javadoc/allclasses-index.html @@ -1,512 +1,287 @@ - - -All Classes (flux-cli 1.1.3 API) + +All Classes and Interfaces (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ +
-

All Classes

-
-
- +
+
+
- diff --git a/docs/assets/javadoc/allclasses.html b/docs/assets/javadoc/allclasses.html deleted file mode 100644 index b4acad94..00000000 --- a/docs/assets/javadoc/allclasses.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - -All Classes (flux-cli 1.1.3 API) - - - - - - - - - - - - -
-

All Classes

-
- -
-
- - diff --git a/docs/assets/javadoc/allpackages-index.html b/docs/assets/javadoc/allpackages-index.html index 78867520..eb846bb5 100644 --- a/docs/assets/javadoc/allpackages-index.html +++ b/docs/assets/javadoc/allpackages-index.html @@ -1,167 +1,68 @@ - - + All Packages (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ +

All Packages

-
-
    -
  • - - - - - - - - - - - - -
    Package Summary 
    PackageDescription
    com.marklogic.flux.api +
    Package Summary
    +
    +
    Package
    +
    Description
    +
    com.marklogic.flux.api
    +
    All Flux functionality can be accessed starting with the Flux class, which provides a static method corresponding to each command available in the Flux CLI.
    -
    -
    • -
+
-
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/AggregateJsonFilesImporter.ReadJsonFilesOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/AggregateJsonFilesImporter.ReadJsonFilesOptions.html index 348b1a0f..dc6847da 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/AggregateJsonFilesImporter.ReadJsonFilesOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/AggregateJsonFilesImporter.ReadJsonFilesOptions.html @@ -1,363 +1,211 @@ - - + AggregateJsonFilesImporter.ReadJsonFilesOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+
+ +
- +
+
-
Package com.marklogic.flux.api
-

Interface AggregateJsonFilesImporter.ReadJsonFilesOptions

+
Package com.marklogic.flux.api
+

Interface AggregateJsonFilesImporter.ReadJsonFilesOptions

-
-
- -
-
-
+
AggregateJsonFilesImporter.ReadJsonFilesOptions
+
uriIncludeFilePath(boolean value)
+
 
+
+
+
+
+

Methods inherited from interface com.marklogic.flux.api.ReadFilesOptions

+abortOnReadFailure, filter, paths, recursiveFileLookup, s3AccessKeyId, s3AddCredentials, s3Endpoint, s3SecretAccessKey
- -
-
- - + -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/AggregateJsonFilesImporter.html b/docs/assets/javadoc/com/marklogic/flux/api/AggregateJsonFilesImporter.html index c845937a..20160ffe 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/AggregateJsonFilesImporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/AggregateJsonFilesImporter.html @@ -1,312 +1,167 @@ - - + AggregateJsonFilesImporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface AggregateJsonFilesImporter

+
Package com.marklogic.flux.api
+

Interface AggregateJsonFilesImporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/AggregateXmlFilesImporter.ReadXmlFilesOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/AggregateXmlFilesImporter.ReadXmlFilesOptions.html index 5847fc37..70da6cf0 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/AggregateXmlFilesImporter.ReadXmlFilesOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/AggregateXmlFilesImporter.ReadXmlFilesOptions.html @@ -1,346 +1,189 @@ - - + AggregateXmlFilesImporter.ReadXmlFilesOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+
+ +
- +
+
-
Package com.marklogic.flux.api
-

Interface AggregateXmlFilesImporter.ReadXmlFilesOptions

+
Package com.marklogic.flux.api
+

Interface AggregateXmlFilesImporter.ReadXmlFilesOptions

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/AggregateXmlFilesImporter.html b/docs/assets/javadoc/com/marklogic/flux/api/AggregateXmlFilesImporter.html index 0542fad7..6e48a93c 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/AggregateXmlFilesImporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/AggregateXmlFilesImporter.html @@ -1,310 +1,165 @@ - - + AggregateXmlFilesImporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface AggregateXmlFilesImporter

+
Package com.marklogic.flux.api
+

Interface AggregateXmlFilesImporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesExporter.ReadArchiveDocumentOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesExporter.ReadArchiveDocumentOptions.html index 945e21f1..15de5c63 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesExporter.ReadArchiveDocumentOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesExporter.ReadArchiveDocumentOptions.html @@ -1,262 +1,135 @@ - - + ArchiveFilesExporter.ReadArchiveDocumentOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+
+ +
- +
+
-
Package com.marklogic.flux.api
-

Interface ArchiveFilesExporter.ReadArchiveDocumentOptions

+
Package com.marklogic.flux.api
+

Interface ArchiveFilesExporter.ReadArchiveDocumentOptions

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesExporter.WriteArchiveFilesOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesExporter.WriteArchiveFilesOptions.html index 3e9b1502..198cfc5b 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesExporter.WriteArchiveFilesOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesExporter.WriteArchiveFilesOptions.html @@ -1,262 +1,135 @@ - - + ArchiveFilesExporter.WriteArchiveFilesOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+
+ +
- +
+
-
Package com.marklogic.flux.api
-

Interface ArchiveFilesExporter.WriteArchiveFilesOptions

+
Package com.marklogic.flux.api
+

Interface ArchiveFilesExporter.WriteArchiveFilesOptions

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesExporter.html b/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesExporter.html index 13662b78..c8188f92 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesExporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesExporter.html @@ -1,333 +1,181 @@ - - + ArchiveFilesExporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface ArchiveFilesExporter

+
Package com.marklogic.flux.api
+

Interface ArchiveFilesExporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesImporter.ReadArchiveFilesOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesImporter.ReadArchiveFilesOptions.html index ccd3b722..6c789b6d 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesImporter.ReadArchiveFilesOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesImporter.ReadArchiveFilesOptions.html @@ -1,290 +1,153 @@ - - + ArchiveFilesImporter.ReadArchiveFilesOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface ArchiveFilesImporter.ReadArchiveFilesOptions

+
Package com.marklogic.flux.api
+

Interface ArchiveFilesImporter.ReadArchiveFilesOptions

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesImporter.html b/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesImporter.html index 6eacc6ff..6ecc3148 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesImporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/ArchiveFilesImporter.html @@ -1,328 +1,178 @@ - - + ArchiveFilesImporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface ArchiveFilesImporter

+
Package com.marklogic.flux.api
+

Interface ArchiveFilesImporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/AuthenticationType.html b/docs/assets/javadoc/com/marklogic/flux/api/AuthenticationType.html index 54a3fa89..4c569404 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/AuthenticationType.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/AuthenticationType.html @@ -1,426 +1,248 @@ - - + AuthenticationType (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Enum AuthenticationType

+
Package com.marklogic.flux.api
+

Enum Class AuthenticationType

-
-
    -
  • java.lang.Object
    • -
  • - -
    • -
-
-
-
-
    -
  • -
    - +
  • +
    +

    Enum Constant Summary

    +
    Enum Constants
    +
    +
    Enum Constant
    +
    Description
    +
    BASIC
    +
     
    +
    CERTIFICATE
    +
     
    +
    CLOUD
    +
     
    +
    DIGEST
    +
     
    +
    KERBEROS
    +
     
    +
    SAML
    +
     
    +
    +
    • -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static AuthenticationTypevalueOf​(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static AuthenticationType[]values() -
      Returns an array containing the constants of this enum type, in +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      static AuthenticationType
      +
      valueOf(String name)
      +
      +
      Returns the enum constant of this class with the specified name.
      +
      +
      static AuthenticationType[]
      +
      values()
      +
      +
      Returns an array containing the constants of this enum class, in the order they are declared.
      -
      • -
        -
      • - - -

        Methods inherited from class java.lang.Enum

        -clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -getClass, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    +
+
+
+
+
+

Methods inherited from class java.lang.Enum

+clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+
+

Methods inherited from class java.lang.Object

+getClass, notify, notifyAll, wait, wait, wait
-
-
-
    -
  • + +
    +
      -
      -
      + -
      -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          values

          -
          public static AuthenticationType[] values()
          -
          Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
          -for (AuthenticationType c : AuthenticationType.values())
-    System.out.println(c);
-
          -
          -
          Returns:
          -
          an array containing the constants of this enum type, in the order they are declared
          +
        • +
          +

          Method Details

          +
            +
          • +
            +

            values

            +
            public static AuthenticationType[] values()
            +
            Returns an array containing the constants of this enum class, in +the order they are declared.
            +
            +
            Returns:
            +
            an array containing the constants of this enum class, in the order they are declared
            +
            • -
          - - - -
            -
          • -

            valueOf

            -
            public static AuthenticationType valueOf​(java.lang.String name)
            -
            Returns the enum constant of this type with the specified name. +
          • +
            +

            valueOf

            +
            public static AuthenticationType valueOf(String name)
            +
            Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are +enum constant in this class. (Extraneous whitespace characters are not permitted.)
            -
            -
            Parameters:
            +
            +
            Parameters:
            name - the name of the enum constant to be returned.
            -
            Returns:
            +
            Returns:
            the enum constant with the specified name
            -
            Throws:
            -
            java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
            -
            java.lang.NullPointerException - if the argument is null
            +
            Throws:
            +
            IllegalArgumentException - if this enum class has no constant with the specified name
            +
            NullPointerException - if the argument is null
            -
            • -
          +
    -
-
- + - diff --git a/docs/assets/javadoc/com/marklogic/flux/api/AvroFilesExporter.html b/docs/assets/javadoc/com/marklogic/flux/api/AvroFilesExporter.html index 76875948..58a86958 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/AvroFilesExporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/AvroFilesExporter.html @@ -1,303 +1,161 @@ - - + AvroFilesExporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface AvroFilesExporter

+
Package com.marklogic.flux.api
+

Interface AvroFilesExporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/AvroFilesImporter.html b/docs/assets/javadoc/com/marklogic/flux/api/AvroFilesImporter.html index 1aeeea9c..d4b734ea 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/AvroFilesImporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/AvroFilesImporter.html @@ -1,289 +1,152 @@ - - + AvroFilesImporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface AvroFilesImporter

+
Package com.marklogic.flux.api
+

Interface AvroFilesImporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/CompressionType.html b/docs/assets/javadoc/com/marklogic/flux/api/CompressionType.html index 7577de09..21c8b077 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/CompressionType.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/CompressionType.html @@ -1,374 +1,216 @@ - - + CompressionType (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+
+ +
- +
+
-
Package com.marklogic.flux.api
-

Enum CompressionType

+
Package com.marklogic.flux.api
+

Enum Class CompressionType

-
-
    -
  • java.lang.Object
    • -
  • -
      -
    • java.lang.Enum<CompressionType>
      • -
    • -
        -
      • com.marklogic.flux.api.CompressionType
        • -
      -
      • -
    -
    • -
-
-
-
-
    -
  • -
    -
      -
    • - - -

      Enum Constant Summary

      - - - - - - - - - - - - - - -
      Enum Constants 
      Enum ConstantDescription
      GZIP 
      ZIP 
      -
      • -
    +
  • +
    +

    Enum Constant Summary

    +
    Enum Constants
    +
    +
    Enum Constant
    +
    Description
    +
    GZIP
    +
     
    +
    ZIP
    +
     
    +
    +
    • -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static CompressionTypevalueOf​(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static CompressionType[]values() -
      Returns an array containing the constants of this enum type, in +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      static CompressionType
      +
      valueOf(String name)
      +
      +
      Returns the enum constant of this class with the specified name.
      +
      +
      static CompressionType[]
      +
      values()
      +
      +
      Returns an array containing the constants of this enum class, in the order they are declared.
      -
      • -
        -
      • - - -

        Methods inherited from class java.lang.Enum

        -clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -getClass, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    +
+
+
+
+
+

Methods inherited from class java.lang.Enum

+clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+
+

Methods inherited from class java.lang.Object

+getClass, notify, notifyAll, wait, wait, wait
-
-
-
    -
  • + +
    +
      -
      -
      + -
      -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          values

          -
          public static CompressionType[] values()
          -
          Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
          -for (CompressionType c : CompressionType.values())
-    System.out.println(c);
-
          -
          -
          Returns:
          -
          an array containing the constants of this enum type, in the order they are declared
          +
        • +
          +

          Method Details

          +
            +
          • +
            +

            values

            +
            public static CompressionType[] values()
            +
            Returns an array containing the constants of this enum class, in +the order they are declared.
            +
            +
            Returns:
            +
            an array containing the constants of this enum class, in the order they are declared
            +
            • -
          - - - -
            -
          • -

            valueOf

            -
            public static CompressionType valueOf​(java.lang.String name)
            -
            Returns the enum constant of this type with the specified name. +
          • +
            +

            valueOf

            +
            public static CompressionType valueOf(String name)
            +
            Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are +enum constant in this class. (Extraneous whitespace characters are not permitted.)
            -
            -
            Parameters:
            +
            +
            Parameters:
            name - the name of the enum constant to be returned.
            -
            Returns:
            +
            Returns:
            the enum constant with the specified name
            -
            Throws:
            -
            java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
            -
            java.lang.NullPointerException - if the argument is null
            +
            Throws:
            +
            IllegalArgumentException - if this enum class has no constant with the specified name
            +
            NullPointerException - if the argument is null
            -
            • -
          +
    -
-
- + - diff --git a/docs/assets/javadoc/com/marklogic/flux/api/ConnectionOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/ConnectionOptions.html index 2653f5b0..a6e918b8 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/ConnectionOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/ConnectionOptions.html @@ -1,582 +1,339 @@ - - + ConnectionOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface ConnectionOptions

+
Package com.marklogic.flux.api
+

Interface ConnectionOptions

-
-
-
    -
  • +
    -
    public interface ConnectionOptions
    -
    • -
-
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/CustomDocumentsExporter.html b/docs/assets/javadoc/com/marklogic/flux/api/CustomDocumentsExporter.html index 41f9449e..a0ac7ec2 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/CustomDocumentsExporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/CustomDocumentsExporter.html @@ -1,273 +1,141 @@ - - + CustomDocumentsExporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface CustomDocumentsExporter

+
Package com.marklogic.flux.api
+

Interface CustomDocumentsExporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/CustomExportWriteOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/CustomExportWriteOptions.html index ccc076f0..21952f9b 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/CustomExportWriteOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/CustomExportWriteOptions.html @@ -1,330 +1,177 @@ - - + CustomExportWriteOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+
+ +
- +
+
-
Package com.marklogic.flux.api
-

Interface CustomExportWriteOptions

+
Package com.marklogic.flux.api
+

Interface CustomExportWriteOptions

-
-
-
    -
  • +
    -
    public interface CustomExportWriteOptions
    -
    • -
-
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/CustomImporter.CustomReadOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/CustomImporter.CustomReadOptions.html index a05731da..f10ef23a 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/CustomImporter.CustomReadOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/CustomImporter.CustomReadOptions.html @@ -1,320 +1,172 @@ - - + CustomImporter.CustomReadOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface CustomImporter.CustomReadOptions

+
Package com.marklogic.flux.api
+

Interface CustomImporter.CustomReadOptions

-
-
-
    -
  • -
    +
    +
    Enclosing interface:
    CustomImporter
    -
    public static interface CustomImporter.CustomReadOptions
    -
    • -
-
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/CustomImporter.html b/docs/assets/javadoc/com/marklogic/flux/api/CustomImporter.html index 9e43b7b8..27d171a2 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/CustomImporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/CustomImporter.html @@ -1,296 +1,156 @@ - - + CustomImporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface CustomImporter

+
Package com.marklogic.flux.api
+

Interface CustomImporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/CustomRowsExporter.html b/docs/assets/javadoc/com/marklogic/flux/api/CustomRowsExporter.html index 575b437b..a40e0d0d 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/CustomRowsExporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/CustomRowsExporter.html @@ -1,287 +1,150 @@ - - + CustomRowsExporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface CustomRowsExporter

+
Package com.marklogic.flux.api
+

Interface CustomRowsExporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/DelimitedFilesExporter.WriteDelimitedFilesOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/DelimitedFilesExporter.WriteDelimitedFilesOptions.html index 71ab6cf5..2f838a73 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/DelimitedFilesExporter.WriteDelimitedFilesOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/DelimitedFilesExporter.WriteDelimitedFilesOptions.html @@ -1,276 +1,144 @@ - - + DelimitedFilesExporter.WriteDelimitedFilesOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface DelimitedFilesExporter.WriteDelimitedFilesOptions

+
Package com.marklogic.flux.api
+

Interface DelimitedFilesExporter.WriteDelimitedFilesOptions

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/DelimitedFilesExporter.html b/docs/assets/javadoc/com/marklogic/flux/api/DelimitedFilesExporter.html index dfe9c5c9..4b3d2e5a 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/DelimitedFilesExporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/DelimitedFilesExporter.html @@ -1,325 +1,175 @@ - - + DelimitedFilesExporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface DelimitedFilesExporter

+
Package com.marklogic.flux.api
+

Interface DelimitedFilesExporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/DelimitedFilesImporter.ReadDelimitedFilesOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/DelimitedFilesImporter.ReadDelimitedFilesOptions.html index c962d4f4..b6a99cbb 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/DelimitedFilesImporter.ReadDelimitedFilesOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/DelimitedFilesImporter.ReadDelimitedFilesOptions.html @@ -1,334 +1,182 @@ - - + DelimitedFilesImporter.ReadDelimitedFilesOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+
+ +
- +
+
-
Package com.marklogic.flux.api
-

Interface DelimitedFilesImporter.ReadDelimitedFilesOptions

+
Package com.marklogic.flux.api
+

Interface DelimitedFilesImporter.ReadDelimitedFilesOptions

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/DelimitedFilesImporter.html b/docs/assets/javadoc/com/marklogic/flux/api/DelimitedFilesImporter.html index 20ecd293..7621ee83 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/DelimitedFilesImporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/DelimitedFilesImporter.html @@ -1,312 +1,167 @@ - - + DelimitedFilesImporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface DelimitedFilesImporter

+
Package com.marklogic.flux.api
+

Interface DelimitedFilesImporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/DocumentCopier.CopyReadDocumentsOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/DocumentCopier.CopyReadDocumentsOptions.html index aa7199d4..8f98bbb0 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/DocumentCopier.CopyReadDocumentsOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/DocumentCopier.CopyReadDocumentsOptions.html @@ -1,262 +1,135 @@ - - + DocumentCopier.CopyReadDocumentsOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+
+ +
- +
+
-
Package com.marklogic.flux.api
-

Interface DocumentCopier.CopyReadDocumentsOptions

+
Package com.marklogic.flux.api
+

Interface DocumentCopier.CopyReadDocumentsOptions

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/DocumentCopier.html b/docs/assets/javadoc/com/marklogic/flux/api/DocumentCopier.html index bb9374d4..b5b81909 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/DocumentCopier.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/DocumentCopier.html @@ -1,324 +1,174 @@ - - + DocumentCopier (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface DocumentCopier

+
Package com.marklogic.flux.api
+

Interface DocumentCopier

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/Executor.html b/docs/assets/javadoc/com/marklogic/flux/api/Executor.html index 2595c2f2..a10aadbe 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/Executor.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/Executor.html @@ -1,367 +1,219 @@ - - + Executor (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+
+ +
- +
+
-
Package com.marklogic.flux.api
-

Interface Executor<T extends Executor>

+
Package com.marklogic.flux.api
+

Interface Executor<T extends Executor>

-
-
- -
-
-
    -
  • + +
    +
+
+
+
-
-
-
    -
  • + +
    +
      -
      -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          execute

          -
          void execute()
          +
        • +
          +

          Method Details

          +
            +
          • +
            +

            execute

            +
            void execute()
            Execute this executor instance with a default Spark session.
            +
            • -
          - - - -
            -
          • -

            withSparkSession

            -
            T withSparkSession​(java.lang.Object sparkSession)
            +
          • +
            +

            withSparkSession

            +
            T withSparkSession(Object sparkSession)
            Execute this executor with a user-defined Spark session.
            -
            -
            Parameters:
            +
            +
            Parameters:
            sparkSession - must be an instance of org.apache.spark.sql.SparkSession. The Spark type is not used here to avoid adding the Spark API and all of its dependencies to the compile-time classpath of clients.
            -
            Returns:
            +
            Returns:
            instance of this executor
            +
            • -
          - - - -
            -
          • -

            connection

            -
            T connection​(java.util.function.Consumer<ConnectionOptions> consumer)
            +
          • +
            +

            connection

            +
            T connection(Consumer<ConnectionOptions> consumer)
            Configure a connection to MarkLogic.
            -
            -
            Parameters:
            +
            +
            Parameters:
            consumer - Provided by the caller to configure the given options object.
            -
            Returns:
            +
            Returns:
            instance of this executor
            +
            • -
          - - - -
            -
          • -

            connectionString

            -
            T connectionString​(java.lang.String connectionString)
            +
          • +
            +

            connectionString

            +
            T connectionString(String connectionString)
            Convenience for the common use case of configuring a MarkLogic connection via a connection string. Requires that the associated MarkLogic REST API app server use basic or digest authentication.
            -
            -
            Parameters:
            +
            +
            Parameters:
            connectionString - Defines a connection to MarkLogic via "user:password@host:port/optionalDatabaseName".
            -
            Returns:
            +
            Returns:
            instance of this executor
            +
            • -
          - - - -
            -
          • -

            limit

            -
            T limit​(int limit)
            +
          • +
            +

            limit

            +
            T limit(int limit)
            Limit the number of records read from the executor's data source.
            -
            -
            Parameters:
            +
            +
            Parameters:
            limit - Maximum number of records to read from the executor's data source.
            -
            Returns:
            +
            Returns:
            instance of this executor
            +
            • -
          - - - -
            -
          • -

            count

            -
            long count()
            -
            -
            Returns:
            +
          • +
            +

            count

            +
            long count()
            +
            +
            Returns:
            the count of rows to be read by this executor from its data source.
            -
            • -
          +
    -
-
- + -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/Flux.html b/docs/assets/javadoc/com/marklogic/flux/api/Flux.html index 31dc4adf..1dbb2cbe 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/Flux.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/Flux.html @@ -1,622 +1,370 @@ - - + Flux (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+
+ +
- +
+
-
Package com.marklogic.flux.api
-

Class Flux

+
Package com.marklogic.flux.api
+

Class Flux

-
-
    -
  • java.lang.Object
    • -
  • -
      -
    • com.marklogic.flux.api.Flux
      • -
    -
    • -
-
-
    -
  • +
    java.lang.Object +
    com.marklogic.flux.api.Flux
    +
    +
    -
    public abstract class Flux
-extends java.lang.Object
    +
    public abstract class Flux +extends Object
    Entry point for executing Flux commands via the API.
    -
    • -
-
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/FluxException.html b/docs/assets/javadoc/com/marklogic/flux/api/FluxException.html index d65fd00b..3189a848 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/FluxException.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/FluxException.html @@ -1,324 +1,167 @@ - - + FluxException (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+
+ +
- +
+
-
Package com.marklogic.flux.api
-

Class FluxException

+
Package com.marklogic.flux.api
+

Class FluxException

-
-
    -
  • java.lang.Object
    • -
  • -
      -
    • java.lang.Throwable
      • -
    • -
        -
      • java.lang.Exception
        • -
      • -
          -
        • java.lang.RuntimeException
          • -
        • -
            -
          • com.marklogic.flux.api.FluxException
            • -
          -
          • -
        -
        • -
      -
      • -
    -
    • -
-
-
-
-
-
-
    -
  • + +
    +
      -
      -
        -
      • - - -

        Constructor Detail

        - - - -
          -
        • -

          FluxException

          -
          public FluxException​(java.lang.String message)
          -
          • -
        - - - -
          -
        • -

          FluxException

          -
          public FluxException​(java.lang.Throwable cause)
          +
        • +
          +

          Constructor Details

          +
            +
          • +
            +

            FluxException

            +
            public FluxException(String message)
            +
            • -
          - - - -
            -
          • -

            FluxException

            -
            public FluxException​(java.lang.String message,
-                     java.lang.Throwable cause)
            +
          • +
            +

            FluxException

            +
            public FluxException(Throwable cause)
            +
            • -
          +
        • +
          +

          FluxException

          +
          public FluxException(String message, + Throwable cause)
          +
    -
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesExporter.WriteGenericFilesOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesExporter.WriteGenericFilesOptions.html index 696d70bb..7c9a1134 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesExporter.WriteGenericFilesOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesExporter.WriteGenericFilesOptions.html @@ -1,362 +1,199 @@ - - + GenericFilesExporter.WriteGenericFilesOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+
+ +
- +
+
-
Package com.marklogic.flux.api
-

Interface GenericFilesExporter.WriteGenericFilesOptions

+
Package com.marklogic.flux.api
+

Interface GenericFilesExporter.WriteGenericFilesOptions

-
-
-
    -
  • -
    +
    +
    Enclosing interface:
    GenericFilesExporter
    -
    public static interface GenericFilesExporter.WriteGenericFilesOptions
    -
    • -
-
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesExporter.html b/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesExporter.html index 769d1ba9..2d64fc0e 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesExporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesExporter.html @@ -1,328 +1,178 @@ - - + GenericFilesExporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface GenericFilesExporter

+
Package com.marklogic.flux.api
+

Interface GenericFilesExporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesImporter.DocumentType.html b/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesImporter.DocumentType.html index 64c1c79f..990c7fb4 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesImporter.DocumentType.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesImporter.DocumentType.html @@ -1,391 +1,228 @@ - - + GenericFilesImporter.DocumentType (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+
+ +
- +
+
-
Package com.marklogic.flux.api
-

Enum GenericFilesImporter.DocumentType

+
Package com.marklogic.flux.api
+

Enum Class GenericFilesImporter.DocumentType

-
- -
-
-
-
    -
  • -
    -
      -
    • - - -

      Enum Constant Summary

      - - - - - - - - - - - - - - - - - - -
      Enum Constants 
      Enum ConstantDescription
      JSON 
      TEXT 
      XML 
      -
      • -
    +
  • +
    +

    Enum Constant Summary

    +
    Enum Constants
    +
    +
    Enum Constant
    +
    Description
    +
    JSON
    +
     
    +
    TEXT
    +
     
    +
    XML
    +
     
    +
    +
    • -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static GenericFilesImporter.DocumentTypevalueOf​(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static GenericFilesImporter.DocumentType[]values() -
      Returns an array containing the constants of this enum type, in +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      static GenericFilesImporter.DocumentType
      +
      valueOf(String name)
      +
      +
      Returns the enum constant of this class with the specified name.
      +
      +
      static GenericFilesImporter.DocumentType[]
      +
      values()
      +
      +
      Returns an array containing the constants of this enum class, in the order they are declared.
      -
      • -
        -
      • - - -

        Methods inherited from class java.lang.Enum

        -clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -getClass, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    +
+
+
+
+
+

Methods inherited from class java.lang.Enum

+clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+
+

Methods inherited from class java.lang.Object

+getClass, notify, notifyAll, wait, wait, wait
-
-
-
    -
  • + +
    +
      -
      -
      + -
      -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          values

          -
          public static GenericFilesImporter.DocumentType[] values()
          -
          Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
          -for (GenericFilesImporter.DocumentType c : GenericFilesImporter.DocumentType.values())
-    System.out.println(c);
-
          -
          -
          Returns:
          -
          an array containing the constants of this enum type, in the order they are declared
          +
        • +
          +

          Method Details

          +
            +
          • +
            +

            values

            +
            public static GenericFilesImporter.DocumentType[] values()
            +
            Returns an array containing the constants of this enum class, in +the order they are declared.
            +
            +
            Returns:
            +
            an array containing the constants of this enum class, in the order they are declared
            +
            • -
          - - - -
            -
          • -

            valueOf

            -
            public static GenericFilesImporter.DocumentType valueOf​(java.lang.String name)
            -
            Returns the enum constant of this type with the specified name. +
          • +
            +

            valueOf

            +
            public static GenericFilesImporter.DocumentType valueOf(String name)
            +
            Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are +enum constant in this class. (Extraneous whitespace characters are not permitted.)
            -
            -
            Parameters:
            +
            +
            Parameters:
            name - the name of the enum constant to be returned.
            -
            Returns:
            +
            Returns:
            the enum constant with the specified name
            -
            Throws:
            -
            java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
            -
            java.lang.NullPointerException - if the argument is null
            +
            Throws:
            +
            IllegalArgumentException - if this enum class has no constant with the specified name
            +
            NullPointerException - if the argument is null
            -
            • -
          +
    -
-
- + - diff --git a/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesImporter.ReadGenericFilesOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesImporter.ReadGenericFilesOptions.html index 8bf357f3..a1b6a3c2 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesImporter.ReadGenericFilesOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesImporter.ReadGenericFilesOptions.html @@ -1,290 +1,153 @@ - - + GenericFilesImporter.ReadGenericFilesOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface GenericFilesImporter.ReadGenericFilesOptions

+
Package com.marklogic.flux.api
+

Interface GenericFilesImporter.ReadGenericFilesOptions

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesImporter.WriteGenericDocumentsOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesImporter.WriteGenericDocumentsOptions.html index 78b961fc..d93b62b9 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesImporter.WriteGenericDocumentsOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesImporter.WriteGenericDocumentsOptions.html @@ -1,262 +1,135 @@ - - + GenericFilesImporter.WriteGenericDocumentsOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+
+ +
- +
+
-
Package com.marklogic.flux.api
-

Interface GenericFilesImporter.WriteGenericDocumentsOptions

+
Package com.marklogic.flux.api
+

Interface GenericFilesImporter.WriteGenericDocumentsOptions

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesImporter.html b/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesImporter.html index 1dd9d996..5f489c60 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesImporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/GenericFilesImporter.html @@ -1,338 +1,184 @@ - - + GenericFilesImporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface GenericFilesImporter

+
Package com.marklogic.flux.api
+

Interface GenericFilesImporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/JdbcExporter.WriteRowsOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/JdbcExporter.WriteRowsOptions.html index a06b3c46..726c1b98 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/JdbcExporter.WriteRowsOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/JdbcExporter.WriteRowsOptions.html @@ -1,276 +1,144 @@ - - + JdbcExporter.WriteRowsOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface JdbcExporter.WriteRowsOptions

+
Package com.marklogic.flux.api
+

Interface JdbcExporter.WriteRowsOptions

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/JdbcExporter.html b/docs/assets/javadoc/com/marklogic/flux/api/JdbcExporter.html index 2c804649..1dc44b03 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/JdbcExporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/JdbcExporter.html @@ -1,311 +1,166 @@ - - + JdbcExporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface JdbcExporter

+
Package com.marklogic.flux.api
+

Interface JdbcExporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/JdbcImporter.ReadJdbcOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/JdbcImporter.ReadJdbcOptions.html index d21a664f..a03a1edb 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/JdbcImporter.ReadJdbcOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/JdbcImporter.ReadJdbcOptions.html @@ -1,292 +1,155 @@ - - + JdbcImporter.ReadJdbcOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface JdbcImporter.ReadJdbcOptions

+
Package com.marklogic.flux.api
+

Interface JdbcImporter.ReadJdbcOptions

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/JdbcImporter.html b/docs/assets/javadoc/com/marklogic/flux/api/JdbcImporter.html index 87999071..021614e2 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/JdbcImporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/JdbcImporter.html @@ -1,298 +1,158 @@ - - + JdbcImporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface JdbcImporter

+
Package com.marklogic.flux.api
+

Interface JdbcImporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/JdbcOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/JdbcOptions.html index 36ec162a..ee5435e1 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/JdbcOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/JdbcOptions.html @@ -1,306 +1,163 @@ - - + JdbcOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface JdbcOptions<T extends JdbcOptions>

+
Package com.marklogic.flux.api
+

Interface JdbcOptions<T extends JdbcOptions>

-
-
- -
-
-
-
-
    -
  • + +
    +
      -
      -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          url

          -
          T url​(java.lang.String url)
          -
          • -
        - - - -
          -
        • -

          driver

          -
          T driver​(java.lang.String driver)
          +
        • +
          +

          Method Details

          + - - - -
            -
          • -

            user

            -
            T user​(java.lang.String user)
            +
          • +
            +

            driver

            +
            T driver(String driver)
            +
            • -
          - - - -
            -
          • -

            password

            -
            T password​(java.lang.String password)
            +
          • +
            +

            user

            +
            T user(String user)
            +
            • -
          - - - -
            -
          • -

            additionalOptions

            -
            T additionalOptions​(java.util.Map<java.lang.String,​java.lang.String> additionalOptions)
            +
          • +
            +

            password

            +
            T password(String password)
            +
            • -
          +
        • +
          +

          additionalOptions

          +
          T additionalOptions(Map<String,String> additionalOptions)
          +
    -
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/JsonLinesFilesExporter.WriteJsonLinesFilesOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/JsonLinesFilesExporter.WriteJsonLinesFilesOptions.html index 508f31ab..219f558a 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/JsonLinesFilesExporter.WriteJsonLinesFilesOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/JsonLinesFilesExporter.WriteJsonLinesFilesOptions.html @@ -1,276 +1,144 @@ - - + JsonLinesFilesExporter.WriteJsonLinesFilesOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface JsonLinesFilesExporter.WriteJsonLinesFilesOptions

+
Package com.marklogic.flux.api
+

Interface JsonLinesFilesExporter.WriteJsonLinesFilesOptions

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/JsonLinesFilesExporter.html b/docs/assets/javadoc/com/marklogic/flux/api/JsonLinesFilesExporter.html index 031bac5d..6a579739 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/JsonLinesFilesExporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/JsonLinesFilesExporter.html @@ -1,325 +1,175 @@ - - + JsonLinesFilesExporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface JsonLinesFilesExporter

+
Package com.marklogic.flux.api
+

Interface JsonLinesFilesExporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/MlcpArchiveFilesImporter.ReadMlcpArchiveFilesOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/MlcpArchiveFilesImporter.ReadMlcpArchiveFilesOptions.html index 0c73ff57..5bc2548e 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/MlcpArchiveFilesImporter.ReadMlcpArchiveFilesOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/MlcpArchiveFilesImporter.ReadMlcpArchiveFilesOptions.html @@ -1,290 +1,153 @@ - - + MlcpArchiveFilesImporter.ReadMlcpArchiveFilesOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface MlcpArchiveFilesImporter.ReadMlcpArchiveFilesOptions

+
Package com.marklogic.flux.api
+

Interface MlcpArchiveFilesImporter.ReadMlcpArchiveFilesOptions

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/MlcpArchiveFilesImporter.html b/docs/assets/javadoc/com/marklogic/flux/api/MlcpArchiveFilesImporter.html index 73579726..4e55b5f1 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/MlcpArchiveFilesImporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/MlcpArchiveFilesImporter.html @@ -1,310 +1,165 @@ - - + MlcpArchiveFilesImporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface MlcpArchiveFilesImporter

+
Package com.marklogic.flux.api
+

Interface MlcpArchiveFilesImporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/OrcFilesExporter.html b/docs/assets/javadoc/com/marklogic/flux/api/OrcFilesExporter.html index b6060886..d24f2268 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/OrcFilesExporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/OrcFilesExporter.html @@ -1,302 +1,160 @@ - - + OrcFilesExporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface OrcFilesExporter

+
Package com.marklogic.flux.api
+

Interface OrcFilesExporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/OrcFilesImporter.html b/docs/assets/javadoc/com/marklogic/flux/api/OrcFilesImporter.html index 4f9b0470..8ac19718 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/OrcFilesImporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/OrcFilesImporter.html @@ -1,289 +1,152 @@ - - + OrcFilesImporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface OrcFilesImporter

+
Package com.marklogic.flux.api
+

Interface OrcFilesImporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/ParquetFilesExporter.html b/docs/assets/javadoc/com/marklogic/flux/api/ParquetFilesExporter.html index 603cf01b..62ed75e4 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/ParquetFilesExporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/ParquetFilesExporter.html @@ -1,302 +1,160 @@ - - + ParquetFilesExporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface ParquetFilesExporter

+
Package com.marklogic.flux.api
+

Interface ParquetFilesExporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/ParquetFilesImporter.html b/docs/assets/javadoc/com/marklogic/flux/api/ParquetFilesImporter.html index b0969da8..571fe7dc 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/ParquetFilesImporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/ParquetFilesImporter.html @@ -1,289 +1,152 @@ - - + ParquetFilesImporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface ParquetFilesImporter

+
Package com.marklogic.flux.api
+

Interface ParquetFilesImporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesExporter.ReadTriplesDocumentsOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesExporter.ReadTriplesDocumentsOptions.html index cddf1f9d..0c7ee25b 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesExporter.ReadTriplesDocumentsOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesExporter.ReadTriplesDocumentsOptions.html @@ -1,411 +1,233 @@ - - + RdfFilesExporter.ReadTriplesDocumentsOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface RdfFilesExporter.ReadTriplesDocumentsOptions

+
Package com.marklogic.flux.api
+

Interface RdfFilesExporter.ReadTriplesDocumentsOptions

-
-
-
    -
  • -
    +
    +
    Enclosing interface:
    RdfFilesExporter
    -
    public static interface RdfFilesExporter.ReadTriplesDocumentsOptions
    -
    • -
-
-
-
+
RdfFilesExporter.ReadTriplesDocumentsOptions
+
options(String options)
+
 
+
RdfFilesExporter.ReadTriplesDocumentsOptions
+
partitionsPerForest(int partitionsPerForest)
+
 
+
RdfFilesExporter.ReadTriplesDocumentsOptions
+
query(String query)
+
 
+
RdfFilesExporter.ReadTriplesDocumentsOptions
+
stringQuery(String stringQuery)
+
 
+
RdfFilesExporter.ReadTriplesDocumentsOptions
+
uris(String... uris)
+
 
+
+
+
-
-
-
-
- + -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesExporter.WriteRdfFilesOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesExporter.WriteRdfFilesOptions.html index 17c0e9af..5e98b73f 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesExporter.WriteRdfFilesOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesExporter.WriteRdfFilesOptions.html @@ -1,290 +1,153 @@ - - + RdfFilesExporter.WriteRdfFilesOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface RdfFilesExporter.WriteRdfFilesOptions

+
Package com.marklogic.flux.api
+

Interface RdfFilesExporter.WriteRdfFilesOptions

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesExporter.html b/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesExporter.html index 3e3dc712..2e165340 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesExporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesExporter.html @@ -1,315 +1,168 @@ - - + RdfFilesExporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface RdfFilesExporter

+
Package com.marklogic.flux.api
+

Interface RdfFilesExporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesImporter.ReadRdfFilesOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesImporter.ReadRdfFilesOptions.html index 385a558e..f55acd1f 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesImporter.ReadRdfFilesOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesImporter.ReadRdfFilesOptions.html @@ -1,276 +1,144 @@ - - + RdfFilesImporter.ReadRdfFilesOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface RdfFilesImporter.ReadRdfFilesOptions

+
Package com.marklogic.flux.api
+

Interface RdfFilesImporter.ReadRdfFilesOptions

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesImporter.WriteTriplesDocumentsOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesImporter.WriteTriplesDocumentsOptions.html index 89004408..45e9a2a9 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesImporter.WriteTriplesDocumentsOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesImporter.WriteTriplesDocumentsOptions.html @@ -1,276 +1,144 @@ - - + RdfFilesImporter.WriteTriplesDocumentsOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface RdfFilesImporter.WriteTriplesDocumentsOptions

+
Package com.marklogic.flux.api
+

Interface RdfFilesImporter.WriteTriplesDocumentsOptions

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesImporter.html b/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesImporter.html index 3b9baba0..c71fced9 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesImporter.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/RdfFilesImporter.html @@ -1,315 +1,168 @@ - - + RdfFilesImporter (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface RdfFilesImporter

+
Package com.marklogic.flux.api
+

Interface RdfFilesImporter

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/ReadDocumentsOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/ReadDocumentsOptions.html index 637a9af7..1c2b39c3 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/ReadDocumentsOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/ReadDocumentsOptions.html @@ -1,425 +1,242 @@ - - + ReadDocumentsOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface ReadDocumentsOptions<T extends ReadDocumentsOptions>

+
Package com.marklogic.flux.api
+

Interface ReadDocumentsOptions<T extends ReadDocumentsOptions>

-
-
- -
-
-
+
T
+
options(String options)
+
 
+
T
+
partitionsPerForest(int partitionsPerForest)
+
 
+
T
+
query(String query)
+
 
+
T
+
stringQuery(String stringQuery)
+
 
+
T
+
transform(String transform)
+
 
+
T
+
transformParams(String delimitedNamesAndValues)
+
 
+
T
+
transformParamsDelimiter(String delimiter)
+
 
+
T
+
uris(String... uris)
+
 
+
+
+
-
-
-
    -
  • + +
    +
      -
      -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          stringQuery

          -
          T stringQuery​(java.lang.String stringQuery)
          +
        • +
          +

          Method Details

          +
            +
          • +
            +

            stringQuery

            +
            T stringQuery(String stringQuery)
            +
            • -
          - - - -
            -
          • -

            uris

            -
            T uris​(java.lang.String... uris)
            +
          • +
            +

            uris

            +
            T uris(String... uris)
            +
            • -
          - - - -
            -
          • -

            query

            -
            T query​(java.lang.String query)
            +
          • +
            +

            query

            +
            T query(String query)
            +
            • -
          - - - -
            -
          • -

            options

            -
            T options​(java.lang.String options)
            +
          • +
            +

            options

            +
            T options(String options)
            +
            • -
          - - - -
            -
          • -

            collections

            -
            T collections​(java.lang.String... collections)
            +
          • +
            +

            collections

            +
            T collections(String... collections)
            +
            • -
          - - - -
            -
          • -

            directory

            -
            T directory​(java.lang.String directory)
            +
          • +
            +

            directory

            +
            T directory(String directory)
            +
            • -
          - - - -
            -
          • -

            logProgress

            -
            T logProgress​(int interval)
            +
          • +
            +

            logProgress

            +
            T logProgress(int interval)
            +
            • -
          - - - -
            -
          • -

            transform

            -
            T transform​(java.lang.String transform)
            +
          • +
            +

            transform

            +
            T transform(String transform)
            +
            • -
          - - - -
            -
          • -

            transformParams

            -
            T transformParams​(java.lang.String delimitedNamesAndValues)
            +
          • +
            +

            transformParams

            +
            T transformParams(String delimitedNamesAndValues)
            +
            • -
          - - - -
            -
          • -

            transformParamsDelimiter

            -
            T transformParamsDelimiter​(java.lang.String delimiter)
            +
          • +
            +

            transformParamsDelimiter

            +
            T transformParamsDelimiter(String delimiter)
            +
            • -
          - - - -
            -
          • -

            batchSize

            -
            T batchSize​(int batchSize)
            +
          • +
            +

            batchSize

            +
            T batchSize(int batchSize)
            +
            • -
          - - - -
            -
          • -

            partitionsPerForest

            -
            T partitionsPerForest​(int partitionsPerForest)
            +
          • +
            +

            partitionsPerForest

            +
            T partitionsPerForest(int partitionsPerForest)
            +
            • -
          - - - -
            -
          • -

            noSnapshot

            -
            T noSnapshot()
            +
          • +
            +

            noSnapshot

            +
            T noSnapshot()
            Read documents at multiple points in time, as opposed to using a consistent snapshot.
            -
            -
            Since:
            +
            +
            Since:
            1.1.2
            -
            • -
          +
    -
-
- + -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/ReadFilesOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/ReadFilesOptions.html index 246e3b58..b414c1c3 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/ReadFilesOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/ReadFilesOptions.html @@ -1,348 +1,190 @@ - - + ReadFilesOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+
+ +
- +
+
-
Package com.marklogic.flux.api
-

Interface ReadFilesOptions<T extends ReadFilesOptions>

+
Package com.marklogic.flux.api
+

Interface ReadFilesOptions<T extends ReadFilesOptions>

-
-
- -
-
-
-
-
    -
  • + +
    +
      -
      -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          paths

          -
          T paths​(java.lang.String... paths)
          -
          • -
        - - - -
          -
        • -

          filter

          -
          T filter​(java.lang.String filter)
          +
        • +
          +

          Method Details

          +
            +
          • +
            +

            paths

            +
            T paths(String... paths)
            +
            • -
          - - - -
            -
          • -

            recursiveFileLookup

            -
            T recursiveFileLookup​(boolean value)
            +
          • +
            +

            filter

            +
            T filter(String filter)
            +
            • -
          - - - -
            -
          • -

            abortOnReadFailure

            -
            T abortOnReadFailure​(boolean value)
            +
          • +
            +

            recursiveFileLookup

            +
            T recursiveFileLookup(boolean value)
            +
            • -
          - - - -
            -
          • -

            s3AddCredentials

            -
            T s3AddCredentials()
            +
          • +
            +

            abortOnReadFailure

            +
            T abortOnReadFailure(boolean value)
            +
            • -
          - - - -
            -
          • -

            s3AccessKeyId

            -
            T s3AccessKeyId​(java.lang.String accessKeyId)
            +
          • +
            +

            s3AddCredentials

            +
            T s3AddCredentials()
            +
            • -
          - - - -
            -
          • -

            s3SecretAccessKey

            -
            T s3SecretAccessKey​(java.lang.String secretAccessKey)
            +
          • +
            +

            s3AccessKeyId

            +
            T s3AccessKeyId(String accessKeyId)
            +
            • -
          - - - -
            -
          • -

            s3Endpoint

            -
            T s3Endpoint​(java.lang.String endpoint)
            +
          • +
            +

            s3SecretAccessKey

            +
            T s3SecretAccessKey(String secretAccessKey)
            +
            • -
          +
        • +
          +

          s3Endpoint

          +
          T s3Endpoint(String endpoint)
          +
    -
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/ReadRowsOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/ReadRowsOptions.html index 4a93240b..e30ae748 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/ReadRowsOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/ReadRowsOptions.html @@ -1,302 +1,159 @@ - - + ReadRowsOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface ReadRowsOptions

+
Package com.marklogic.flux.api
+

Interface ReadRowsOptions

-
-
-
    -
  • +
    -
    public interface ReadRowsOptions
    -
    • -
-
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/ReadTabularFilesOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/ReadTabularFilesOptions.html index 598058b9..6895d622 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/ReadTabularFilesOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/ReadTabularFilesOptions.html @@ -1,304 +1,162 @@ - - + ReadTabularFilesOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface ReadTabularFilesOptions

+
Package com.marklogic.flux.api
+

Interface ReadTabularFilesOptions

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/Reprocessor.ReadOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/Reprocessor.ReadOptions.html index ace3f3c4..10f0bc1d 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/Reprocessor.ReadOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/Reprocessor.ReadOptions.html @@ -1,404 +1,226 @@ - - + Reprocessor.ReadOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface Reprocessor.ReadOptions

+
Package com.marklogic.flux.api
+

Interface Reprocessor.ReadOptions

-
-
-
    -
  • -
    +
    +
    Enclosing interface:
    Reprocessor
    -
    public static interface Reprocessor.ReadOptions
    -
    • -
-
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/Reprocessor.WriteOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/Reprocessor.WriteOptions.html index 84ad1e67..9b2ae353 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/Reprocessor.WriteOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/Reprocessor.WriteOptions.html @@ -1,390 +1,217 @@ - - + Reprocessor.WriteOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface Reprocessor.WriteOptions

+
Package com.marklogic.flux.api
+

Interface Reprocessor.WriteOptions

-
-
-
    -
  • -
    +
    +
    Enclosing interface:
    Reprocessor
    -
    public static interface Reprocessor.WriteOptions
    -
    • -
-
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/Reprocessor.html b/docs/assets/javadoc/com/marklogic/flux/api/Reprocessor.html index 801709f7..fa6fb3f9 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/Reprocessor.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/Reprocessor.html @@ -1,301 +1,159 @@ - - + Reprocessor (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface Reprocessor

+
Package com.marklogic.flux.api
+

Interface Reprocessor

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/SaveMode.html b/docs/assets/javadoc/com/marklogic/flux/api/SaveMode.html index cf418a46..7cefba4a 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/SaveMode.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/SaveMode.html @@ -1,401 +1,233 @@ - - + SaveMode (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+
+ +
- +
+
-
Package com.marklogic.flux.api
-

Enum SaveMode

+
Package com.marklogic.flux.api
+

Enum Class SaveMode

-
-
    -
  • java.lang.Object
    • -
  • -
      -
    • java.lang.Enum<SaveMode>
      • -
    • -
        -
      • com.marklogic.flux.api.SaveMode
        • -
      -
      • -
    -
    • -
-
-
-
-
    -
  • -
    - +
  • +
    +

    Enum Constant Summary

    +
    Enum Constants
    +
    +
    Enum Constant
    +
    Description
    +
    APPEND
    +
     
    +
    ERRORIFEXISTS
    +
     
    +
    IGNORE
    +
     
    +
    OVERWRITE
    +
     
    +
    +
    • -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static SaveModevalueOf​(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static SaveMode[]values() -
      Returns an array containing the constants of this enum type, in +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      static SaveMode
      +
      valueOf(String name)
      +
      +
      Returns the enum constant of this class with the specified name.
      +
      +
      static SaveMode[]
      +
      values()
      +
      +
      Returns an array containing the constants of this enum class, in the order they are declared.
      -
      • -
        -
      • - - -

        Methods inherited from class java.lang.Enum

        -clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -getClass, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    +
+
+
+
+
+

Methods inherited from class java.lang.Enum

+clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+
+

Methods inherited from class java.lang.Object

+getClass, notify, notifyAll, wait, wait, wait
-
-
-
    -
  • + +
    +
      -
      -
        -
      • - - -

        Enum Constant Detail

        - - - -
          -
        • -

          APPEND

          -
          public static final SaveMode APPEND
          -
          • -
        - - - -
          -
        • -

          OVERWRITE

          -
          public static final SaveMode OVERWRITE
          +
        • +
          +

          Enum Constant Details

          +
            +
          • +
            +

            APPEND

            +
            public static final SaveMode APPEND
            +
            • -
          - - - -
            -
          • -

            ERRORIFEXISTS

            -
            public static final SaveMode ERRORIFEXISTS
            +
          • +
            +

            OVERWRITE

            +
            public static final SaveMode OVERWRITE
            +
            • -
          - - - -
            -
          • -

            IGNORE

            -
            public static final SaveMode IGNORE
            +
          • +
            +

            ERRORIFEXISTS

            +
            public static final SaveMode ERRORIFEXISTS
            +
            • -
          +
        • +
          +

          IGNORE

          +
          public static final SaveMode IGNORE
          +
      + -
      -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          values

          -
          public static SaveMode[] values()
          -
          Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
          -for (SaveMode c : SaveMode.values())
-    System.out.println(c);
-
          -
          -
          Returns:
          -
          an array containing the constants of this enum type, in the order they are declared
          +
        • +
          +

          Method Details

          +
            +
          • +
            +

            values

            +
            public static SaveMode[] values()
            +
            Returns an array containing the constants of this enum class, in +the order they are declared.
            +
            +
            Returns:
            +
            an array containing the constants of this enum class, in the order they are declared
            +
            • -
          - - - -
            -
          • -

            valueOf

            -
            public static SaveMode valueOf​(java.lang.String name)
            -
            Returns the enum constant of this type with the specified name. +
          • +
            +

            valueOf

            +
            public static SaveMode valueOf(String name)
            +
            Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are +enum constant in this class. (Extraneous whitespace characters are not permitted.)
            -
            -
            Parameters:
            +
            +
            Parameters:
            name - the name of the enum constant to be returned.
            -
            Returns:
            +
            Returns:
            the enum constant with the specified name
            -
            Throws:
            -
            java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
            -
            java.lang.NullPointerException - if the argument is null
            +
            Throws:
            +
            IllegalArgumentException - if this enum class has no constant with the specified name
            +
            NullPointerException - if the argument is null
            -
            • -
          +
    -
-
- + - diff --git a/docs/assets/javadoc/com/marklogic/flux/api/SslHostnameVerifier.html b/docs/assets/javadoc/com/marklogic/flux/api/SslHostnameVerifier.html index b4aadd98..823b16dd 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/SslHostnameVerifier.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/SslHostnameVerifier.html @@ -1,387 +1,224 @@ - - + SslHostnameVerifier (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+
+ +
- +
+
-
Package com.marklogic.flux.api
-

Enum SslHostnameVerifier

+
Package com.marklogic.flux.api
+

Enum Class SslHostnameVerifier

-
-
    -
  • java.lang.Object
    • -
  • - -
    • -
-
-
-
-
    -
  • -
    -
      -
    • - - -

      Enum Constant Summary

      - - - - - - - - - - - - - - - - - - -
      Enum Constants 
      Enum ConstantDescription
      ANY 
      COMMON 
      STRICT 
      -
      • -
    +
  • +
    +

    Enum Constant Summary

    +
    Enum Constants
    +
    +
    Enum Constant
    +
    Description
    +
    ANY
    +
     
    +
    COMMON
    +
     
    +
    STRICT
    +
     
    +
    +
    • -
    -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - -
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static SslHostnameVerifiervalueOf​(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static SslHostnameVerifier[]values() -
      Returns an array containing the constants of this enum type, in +
    • +
      +

      Method Summary

      +
      +
      +
      +
      +
      Modifier and Type
      +
      Method
      +
      Description
      +
      static SslHostnameVerifier
      +
      valueOf(String name)
      +
      +
      Returns the enum constant of this class with the specified name.
      +
      +
      static SslHostnameVerifier[]
      +
      values()
      +
      +
      Returns an array containing the constants of this enum class, in the order they are declared.
      -
      • -
        -
      • - - -

        Methods inherited from class java.lang.Enum

        -clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -getClass, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    +
+
+
+
+
+

Methods inherited from class java.lang.Enum

+clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+
+

Methods inherited from class java.lang.Object

+getClass, notify, notifyAll, wait, wait, wait
-
-
-
    -
  • + +
    +
      -
      -
      + -
      -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          values

          -
          public static SslHostnameVerifier[] values()
          -
          Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
          -for (SslHostnameVerifier c : SslHostnameVerifier.values())
-    System.out.println(c);
-
          -
          -
          Returns:
          -
          an array containing the constants of this enum type, in the order they are declared
          +
        • +
          +

          Method Details

          +
            +
          • +
            +

            values

            +
            public static SslHostnameVerifier[] values()
            +
            Returns an array containing the constants of this enum class, in +the order they are declared.
            +
            +
            Returns:
            +
            an array containing the constants of this enum class, in the order they are declared
            +
            • -
          - - - -
            -
          • -

            valueOf

            -
            public static SslHostnameVerifier valueOf​(java.lang.String name)
            -
            Returns the enum constant of this type with the specified name. +
          • +
            +

            valueOf

            +
            public static SslHostnameVerifier valueOf(String name)
            +
            Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are +enum constant in this class. (Extraneous whitespace characters are not permitted.)
            -
            -
            Parameters:
            +
            +
            Parameters:
            name - the name of the enum constant to be returned.
            -
            Returns:
            +
            Returns:
            the enum constant with the specified name
            -
            Throws:
            -
            java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
            -
            java.lang.NullPointerException - if the argument is null
            +
            Throws:
            +
            IllegalArgumentException - if this enum class has no constant with the specified name
            +
            NullPointerException - if the argument is null
            -
            • -
          +
    -
-
- + - diff --git a/docs/assets/javadoc/com/marklogic/flux/api/WriteDocumentsOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/WriteDocumentsOptions.html index 40e2a6da..82ff5c99 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/WriteDocumentsOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/WriteDocumentsOptions.html @@ -1,474 +1,271 @@ - - + WriteDocumentsOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+
+ +
- +
+
-
Package com.marklogic.flux.api
-

Interface WriteDocumentsOptions<T extends WriteDocumentsOptions>

+
Package com.marklogic.flux.api
+

Interface WriteDocumentsOptions<T extends WriteDocumentsOptions>

-
-
- -
-
-
-
-
    -
  • + +
    +
      -
      -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          abortOnWriteFailure

          -
          T abortOnWriteFailure​(boolean value)
          -
          • -
        - - - -
          -
        • -

          batchSize

          -
          T batchSize​(int batchSize)
          +
        • +
          +

          Method Details

          +
            +
          • +
            +

            abortOnWriteFailure

            +
            T abortOnWriteFailure(boolean value)
            +
            • -
          - - - -
            -
          • -

            collections

            -
            T collections​(java.lang.String... collections)
            +
          • +
            +

            batchSize

            +
            T batchSize(int batchSize)
            +
            • -
          - - - -
            -
          • -

            collectionsString

            -
            T collectionsString​(java.lang.String commaDelimitedCollections)
            +
          • +
            +

            collections

            +
            T collections(String... collections)
            +
            • -
          - - - -
            -
          • -

            failedDocumentsPath

            -
            T failedDocumentsPath​(java.lang.String path)
            +
          • +
            +

            collectionsString

            +
            T collectionsString(String commaDelimitedCollections)
            +
            • -
          - - - -
            -
          • -

            logProgress

            -
            T logProgress​(int interval)
            +
          • +
            +

            failedDocumentsPath

            +
            T failedDocumentsPath(String path)
            +
            • -
          - - - -
            -
          • -

            permissionsString

            -
            T permissionsString​(java.lang.String rolesAndCapabilities)
            +
          • +
            +

            logProgress

            +
            T logProgress(int interval)
            +
            • -
          - - - -
            -
          • -

            temporalCollection

            -
            T temporalCollection​(java.lang.String temporalCollection)
            +
          • +
            +

            permissionsString

            +
            T permissionsString(String rolesAndCapabilities)
            +
            • -
          - - - -
            -
          • -

            threadCount

            -
            T threadCount​(int threadCount)
            +
          • +
            +

            temporalCollection

            +
            T temporalCollection(String temporalCollection)
            +
            • -
          - - - -
            -
          • -

            threadCountPerPartition

            -
            T threadCountPerPartition​(int threadCountPerPartition)
            +
          • +
            +

            threadCount

            +
            T threadCount(int threadCount)
            +
            • -
          - - - -
            -
          • -

            transform

            -
            T transform​(java.lang.String transform)
            +
          • +
            +

            threadCountPerPartition

            +
            T threadCountPerPartition(int threadCountPerPartition)
            +
            • -
          - - - -
            -
          • -

            transformParams

            -
            T transformParams​(java.lang.String delimitedNamesAndValues)
            +
          • +
            +

            transform

            +
            T transform(String transform)
            +
            • -
          - - - -
            -
          • -

            transformParamsDelimiter

            -
            T transformParamsDelimiter​(java.lang.String delimiter)
            +
          • +
            +

            transformParams

            +
            T transformParams(String delimitedNamesAndValues)
            +
            • -
          - - - -
            -
          • -

            uriPrefix

            -
            T uriPrefix​(java.lang.String uriPrefix)
            +
          • +
            +

            transformParamsDelimiter

            +
            T transformParamsDelimiter(String delimiter)
            +
            • -
          - - - -
            -
          • -

            uriReplace

            -
            T uriReplace​(java.lang.String uriReplace)
            +
          • +
            +

            uriPrefix

            +
            T uriPrefix(String uriPrefix)
            +
            • -
          - - - -
            -
          • -

            uriSuffix

            -
            T uriSuffix​(java.lang.String uriSuffix)
            +
          • +
            +

            uriReplace

            +
            T uriReplace(String uriReplace)
            +
            • -
          - - - -
            -
          • -

            uriTemplate

            -
            T uriTemplate​(java.lang.String uriTemplate)
            +
          • +
            +

            uriSuffix

            +
            T uriSuffix(String uriSuffix)
            +
            • -
          +
        • +
          +

          uriTemplate

          +
          T uriTemplate(String uriTemplate)
          +
    -
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/WriteFilesOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/WriteFilesOptions.html index abea3d4b..72aa7594 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/WriteFilesOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/WriteFilesOptions.html @@ -1,320 +1,172 @@ - - + WriteFilesOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface WriteFilesOptions<T extends WriteFilesOptions>

+
Package com.marklogic.flux.api
+

Interface WriteFilesOptions<T extends WriteFilesOptions>

-
-
- -
-
-
-
-
    -
  • + +
    +
      -
      -
        -
      • - - -

        Method Detail

        - - - -
          -
        • -

          path

          -
          T path​(java.lang.String path)
          -
          • -
        - - - -
          -
        • -

          fileCount

          -
          T fileCount​(int fileCount)
          +
        • +
          +

          Method Details

          +
            +
          • +
            +

            path

            +
            T path(String path)
            +
            • -
          - - - -
            -
          • -

            s3AddCredentials

            -
            T s3AddCredentials()
            +
          • +
            +

            fileCount

            +
            T fileCount(int fileCount)
            +
            • -
          - - - -
            -
          • -

            s3Endpoint

            -
            T s3Endpoint​(java.lang.String endpoint)
            +
          • +
            +

            s3AddCredentials

            +
            T s3AddCredentials()
            +
            • -
          - - - -
            -
          • -

            s3AccessKeyId

            -
            T s3AccessKeyId​(java.lang.String accessKeyId)
            +
          • +
            +

            s3Endpoint

            +
            T s3Endpoint(String endpoint)
            +
            • -
          - - - -
            -
          • -

            s3SecretAccessKey

            -
            T s3SecretAccessKey​(java.lang.String secretAccessKey)
            +
          • +
            +

            s3AccessKeyId

            +
            T s3AccessKeyId(String accessKeyId)
            +
            • -
          +
        • +
          +

          s3SecretAccessKey

          +
          T s3SecretAccessKey(String secretAccessKey)
          +
    -
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/WriteSparkFilesOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/WriteSparkFilesOptions.html index 732fa2c1..2bfa2a5b 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/WriteSparkFilesOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/WriteSparkFilesOptions.html @@ -1,260 +1,133 @@ - - + WriteSparkFilesOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+
+ +
- +
+
-
Package com.marklogic.flux.api
-

Interface WriteSparkFilesOptions

+
Package com.marklogic.flux.api
+

Interface WriteSparkFilesOptions

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/WriteStructuredDocumentsOptions.html b/docs/assets/javadoc/com/marklogic/flux/api/WriteStructuredDocumentsOptions.html index fb27d39a..b489e182 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/WriteStructuredDocumentsOptions.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/WriteStructuredDocumentsOptions.html @@ -1,309 +1,167 @@ - - + WriteStructuredDocumentsOptions (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ - +
+
-
Package com.marklogic.flux.api
-

Interface WriteStructuredDocumentsOptions

+
Package com.marklogic.flux.api
+

Interface WriteStructuredDocumentsOptions

-
-
- -
-
-
-
-
-
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/package-summary.html b/docs/assets/javadoc/com/marklogic/flux/api/package-summary.html index 423cd28a..0779cfdc 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/package-summary.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/package-summary.html @@ -1,103 +1,69 @@ - - + com.marklogic.flux.api (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ +
-

Package com.marklogic.flux.api

+

Package com.marklogic.flux.api

-
-
- - +
+
package com.marklogic.flux.api
+

All Flux functionality can be accessed starting with the Flux class, which provides a static method corresponding to each @@ -123,447 +89,241 @@

Package com.marklogic.flux.api

.execute();
-
+
+
+
-
+ -
- -
diff --git a/docs/assets/javadoc/com/marklogic/flux/api/package-tree.html b/docs/assets/javadoc/com/marklogic/flux/api/package-tree.html index dc511dbf..a5c78aa2 100644 --- a/docs/assets/javadoc/com/marklogic/flux/api/package-tree.html +++ b/docs/assets/javadoc/com/marklogic/flux/api/package-tree.html @@ -1,113 +1,67 @@ - - + com.marklogic.flux.api Class Hierarchy (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ +

Hierarchy For Package com.marklogic.flux.api

-
-
+

Class Hierarchy

-
+

Interface Hierarchy

-
-

Enum Hierarchy

+
+

Enum Class Hierarchy

-
-
- -
diff --git a/docs/assets/javadoc/constant-values.html b/docs/assets/javadoc/constant-values.html deleted file mode 100644 index 8fe38919..00000000 --- a/docs/assets/javadoc/constant-values.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - -Constant Field Values (flux-cli 1.1.3 API) - - - - - - - - - - - - - - -
- -
-
-
-

Constant Field Values

-
-

Contents

-
-
-
-
- -
- - diff --git a/docs/assets/javadoc/deprecated-list.html b/docs/assets/javadoc/deprecated-list.html index 403240be..8f0507c5 100644 --- a/docs/assets/javadoc/deprecated-list.html +++ b/docs/assets/javadoc/deprecated-list.html @@ -1,193 +1,91 @@ - - + Deprecated List (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ +

Deprecated API

Contents

-
- - -
-
- -
diff --git a/docs/assets/javadoc/help-doc.html b/docs/assets/javadoc/help-doc.html index 8d9844a2..44ddf17c 100644 --- a/docs/assets/javadoc/help-doc.html +++ b/docs/assets/javadoc/help-doc.html @@ -1,121 +1,114 @@ - - + API Help (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ +
-
-

How This API Document Is Organized

-
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+

JavaDoc Help

+ +
+
+

Navigation

+Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces +
-
-
    -
  • -
    -

    Package

    -

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain six categories:

    -
      +
      +
      +

      Kinds of Pages

      +The following sections describe the different kinds of pages in this collection. +
      +

      Package

      +

      Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:

      +
      • Interfaces
      • Classes
        • -
      • Enums
        • +
      • Enum Classes
      • Exceptions
      • Errors
        • -
      • Annotation Types
        • +
      • Annotation Interfaces
      - -
    • -
      -

      Class or Interface

      -

      Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

      -
        +
        +

        Class or Interface

        +

        Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.

        +
        • Class Inheritance Diagram
        • Direct Subclasses
        • All Known Subinterfaces
          • @@ -124,141 +117,64 @@

          Class or Interface

        • Class or Interface Description

        -
          +
          • Nested Class Summary
            • +
          • Enum Constant Summary
          • Field Summary
          • Property Summary
          • Constructor Summary
          • Method Summary
            • -
          -
          -
            -
          • Field Detail
            • -
          • Property Detail
            • -
          • Constructor Detail
            • -
          • Method Detail
            • -
          -

          Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

          -
        - -
      • -
        -

        Annotation Type

        -

        Each annotation type has its own separate page with the following sections:

        -
          -
        • Annotation Type Declaration
          • -
        • Annotation Type Description
        • Required Element Summary
        • Optional Element Summary
          • -
        • Element Detail
        -
        -
        • -
      • -
        -

        Enum

        -

        Each enum has its own separate page with the following sections:

        -
          -
        • Enum Declaration
          • -
        • Enum Description
          • -
        • Enum Constant Summary
          • -
        • Enum Constant Detail
          • +
          +
            +
          • Enum Constant Details
            • +
          • Field Details
            • +
          • Property Details
            • +
          • Constructor Details
            • +
          • Method Details
            • +
          • Element Details
          +

          Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.

          +

          The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

        -
        • -
      • -
        -

        Tree (Class Hierarchy)

        +
        +

        Other Files

        +

        Packages and modules may contain pages with additional information related to the declarations nearby.

        +
        +
        +

        Tree (Class Hierarchy)

        There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.

        -
          -
        • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
          • -
        • When viewing a particular package, class or interface page, clicking on "Tree" displays the hierarchy for only that package.
          • +
            +
          • When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
            • +
          • When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
        -
        • -
      • -
        -

        Deprecated API

        -

        The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

        -
        -
        • -
      • -
        -

        Index

        -

        The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields, as well as lists of all packages and all classes.

        +
        +

        Deprecated API

        +

        The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to shortcomings, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

        -
        • -
      • -
        -

        All Classes

        -

        The All Classes link shows all classes and interfaces except non-static nested types.

        +
        +

        Serialized Form

        +

        Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.

        -
        • -
      • -
        -

        Serialized Form

        -

        Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

        +
        +

        All Packages

        +

        The All Packages page contains an alphabetic index of all packages contained in the documentation.

        -
        • -
      • -
        -

        Constant Field Values

        -

        The Constant Field Values page lists the static final fields and their values.

        +
        +

        All Classes and Interfaces

        +

        The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.

        -
        • -
      • -
        -

        Search

        -

        You can search for definitions of modules, packages, types, fields, methods and other terms defined in the API, using some or all of the name. "Camel-case" abbreviations are supported: for example, "InpStr" will find "InputStream" and "InputStreamReader".

        +
        +

        Index

        +

        The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.

        -
        • -
      +
      • -This help file applies to API documentation generated by the standard doclet.
-
-
- -
diff --git a/docs/assets/javadoc/index-all.html b/docs/assets/javadoc/index-all.html index 26ba481f..77532e12 100644 --- a/docs/assets/javadoc/index-all.html +++ b/docs/assets/javadoc/index-all.html @@ -1,232 +1,182 @@ - - + Index (flux-cli 1.1.3 API) + + + - + - - - - - + + - - -
+
+ +
-
A B C D E F G H I J K L M N O P Q R S T U V W X Z 
All Classes All Packages - - -

A

-
-
abortOnReadFailure(boolean) - Method in interface com.marklogic.flux.api.ReadFilesOptions
+
+

Index

+
+A B C D E F G H I J K L M N O P Q R S T U V W X Z 
All Classes and Interfaces|All Packages|Serialized Form +

A

+
+
abortOnReadFailure(boolean) - Method in interface com.marklogic.flux.api.ReadFilesOptions
 
-
abortOnWriteFailure(boolean) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
+
abortOnWriteFailure(boolean) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
 
-
abortOnWriteFailure(boolean) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
+
abortOnWriteFailure(boolean) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
 
-
additionalOptions(Map<String, String>) - Method in interface com.marklogic.flux.api.AggregateJsonFilesImporter.ReadJsonFilesOptions
+
additionalOptions(Map<String, String>) - Method in interface com.marklogic.flux.api.AggregateJsonFilesImporter.ReadJsonFilesOptions
 
-
additionalOptions(Map<String, String>) - Method in interface com.marklogic.flux.api.CustomExportWriteOptions
+
additionalOptions(Map<String, String>) - Method in interface com.marklogic.flux.api.CustomExportWriteOptions
 
-
additionalOptions(Map<String, String>) - Method in interface com.marklogic.flux.api.CustomImporter.CustomReadOptions
+
additionalOptions(Map<String, String>) - Method in interface com.marklogic.flux.api.CustomImporter.CustomReadOptions
 
-
additionalOptions(Map<String, String>) - Method in interface com.marklogic.flux.api.DelimitedFilesExporter.WriteDelimitedFilesOptions
+
additionalOptions(Map<String, String>) - Method in interface com.marklogic.flux.api.DelimitedFilesExporter.WriteDelimitedFilesOptions
 
-
additionalOptions(Map<String, String>) - Method in interface com.marklogic.flux.api.DelimitedFilesImporter.ReadDelimitedFilesOptions
+
additionalOptions(Map<String, String>) - Method in interface com.marklogic.flux.api.DelimitedFilesImporter.ReadDelimitedFilesOptions
 
-
additionalOptions(Map<String, String>) - Method in interface com.marklogic.flux.api.JdbcOptions
+
additionalOptions(Map<String, String>) - Method in interface com.marklogic.flux.api.JdbcOptions
 
-
additionalOptions(Map<String, String>) - Method in interface com.marklogic.flux.api.JsonLinesFilesExporter.WriteJsonLinesFilesOptions
+
additionalOptions(Map<String, String>) - Method in interface com.marklogic.flux.api.JsonLinesFilesExporter.WriteJsonLinesFilesOptions
 
-
additionalOptions(Map<String, String>) - Method in interface com.marklogic.flux.api.ReadTabularFilesOptions
+
additionalOptions(Map<String, String>) - Method in interface com.marklogic.flux.api.ReadTabularFilesOptions
 
-
additionalOptions(Map<String, String>) - Method in interface com.marklogic.flux.api.WriteSparkFilesOptions
+
additionalOptions(Map<String, String>) - Method in interface com.marklogic.flux.api.WriteSparkFilesOptions
 
-
aggregateColumns(String, String...) - Method in interface com.marklogic.flux.api.DelimitedFilesImporter.ReadDelimitedFilesOptions
+
aggregateColumns(String, String...) - Method in interface com.marklogic.flux.api.DelimitedFilesImporter.ReadDelimitedFilesOptions
 
-
aggregateColumns(String, String...) - Method in interface com.marklogic.flux.api.JdbcImporter.ReadJdbcOptions
+
aggregateColumns(String, String...) - Method in interface com.marklogic.flux.api.JdbcImporter.ReadJdbcOptions
 
-
aggregateColumns(String, String...) - Method in interface com.marklogic.flux.api.ReadTabularFilesOptions
+
aggregateColumns(String, String...) - Method in interface com.marklogic.flux.api.ReadTabularFilesOptions
 
-
AggregateJsonFilesImporter - Interface in com.marklogic.flux.api
+
AggregateJsonFilesImporter - Interface in com.marklogic.flux.api
Read either JSON Lines files or files containing arrays of JSON objects from local, HDFS, and S3 locations using Spark's JSON support, and write each object as a JSON document to MarkLogic.
-
AggregateJsonFilesImporter.ReadJsonFilesOptions - Interface in com.marklogic.flux.api
+
AggregateJsonFilesImporter.ReadJsonFilesOptions - Interface in com.marklogic.flux.api
 
-
AggregateXmlFilesImporter - Interface in com.marklogic.flux.api
+
AggregateXmlFilesImporter - Interface in com.marklogic.flux.api
Read aggregate XML files from local, HDFS, and S3 locations with each row being written to MarkLogic.
-
AggregateXmlFilesImporter.ReadXmlFilesOptions - Interface in com.marklogic.flux.api
+
AggregateXmlFilesImporter.ReadXmlFilesOptions - Interface in com.marklogic.flux.api
 
-
ANY - com.marklogic.flux.api.SslHostnameVerifier
+
ANY - Enum constant in enum class com.marklogic.flux.api.SslHostnameVerifier
 
-
APPEND - com.marklogic.flux.api.SaveMode
+
APPEND - Enum constant in enum class com.marklogic.flux.api.SaveMode
 
-
ArchiveFilesExporter - Interface in com.marklogic.flux.api
+
ArchiveFilesExporter - Interface in com.marklogic.flux.api
Read documents and their metadata from MarkLogic and write them to ZIP files on a local filesystem, HDFS, or S3.
-
ArchiveFilesExporter.ReadArchiveDocumentOptions - Interface in com.marklogic.flux.api
+
ArchiveFilesExporter.ReadArchiveDocumentOptions - Interface in com.marklogic.flux.api
 
-
ArchiveFilesExporter.WriteArchiveFilesOptions - Interface in com.marklogic.flux.api
+
ArchiveFilesExporter.WriteArchiveFilesOptions - Interface in com.marklogic.flux.api
 
-
ArchiveFilesImporter - Interface in com.marklogic.flux.api
+
ArchiveFilesImporter - Interface in com.marklogic.flux.api
Read local, HDFS, and S3 Flux archive files and write the documents in each archive to MarkLogic.
-
ArchiveFilesImporter.ReadArchiveFilesOptions - Interface in com.marklogic.flux.api
+
ArchiveFilesImporter.ReadArchiveFilesOptions - Interface in com.marklogic.flux.api
 
-
authenticationType(AuthenticationType) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
authenticationType(AuthenticationType) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
AuthenticationType - Enum in com.marklogic.flux.api
+
AuthenticationType - Enum Class in com.marklogic.flux.api
 
-
AvroFilesExporter - Interface in com.marklogic.flux.api
+
AvroFilesExporter - Interface in com.marklogic.flux.api
Read rows via Optic from MarkLogic and write them to Avro files on a local filesystem, HDFS, or S3 using Spark's Avro support.
-
AvroFilesImporter - Interface in com.marklogic.flux.api
+
AvroFilesImporter - Interface in com.marklogic.flux.api
Read Avro files from local, HDFS, and S3 locations using Spark's Avro support, and write JSON or XML documents to MarkLogic.
- - - -

B

-
-
baseIri(String) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
+

B

+
+
baseIri(String) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
 
-
basePath(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
basePath(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
BASIC - com.marklogic.flux.api.AuthenticationType
+
BASIC - Enum constant in enum class com.marklogic.flux.api.AuthenticationType
 
-
batchSize(int) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
+
batchSize(int) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
 
-
batchSize(int) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
+
batchSize(int) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
 
-
batchSize(int) - Method in interface com.marklogic.flux.api.ReadRowsOptions
+
batchSize(int) - Method in interface com.marklogic.flux.api.ReadRowsOptions
 
-
batchSize(int) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
+
batchSize(int) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
 
-
batchSize(int) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
+
batchSize(int) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
 
- - - -

C

-
-
categories(String...) - Method in interface com.marklogic.flux.api.ArchiveFilesExporter.ReadArchiveDocumentOptions
+

C

+
+
categories(String...) - Method in interface com.marklogic.flux.api.ArchiveFilesExporter.ReadArchiveDocumentOptions
 
-
categories(String...) - Method in interface com.marklogic.flux.api.ArchiveFilesImporter.ReadArchiveFilesOptions
+
categories(String...) - Method in interface com.marklogic.flux.api.ArchiveFilesImporter.ReadArchiveFilesOptions
 
-
categories(String...) - Method in interface com.marklogic.flux.api.DocumentCopier.CopyReadDocumentsOptions
+
categories(String...) - Method in interface com.marklogic.flux.api.DocumentCopier.CopyReadDocumentsOptions
 
-
categories(String...) - Method in interface com.marklogic.flux.api.MlcpArchiveFilesImporter.ReadMlcpArchiveFilesOptions
+
categories(String...) - Method in interface com.marklogic.flux.api.MlcpArchiveFilesImporter.ReadMlcpArchiveFilesOptions
 
-
CERTIFICATE - com.marklogic.flux.api.AuthenticationType
+
CERTIFICATE - Enum constant in enum class com.marklogic.flux.api.AuthenticationType
 
-
certificateFile(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
certificateFile(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
certificatePassword(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
certificatePassword(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
CLOUD - com.marklogic.flux.api.AuthenticationType
+
CLOUD - Enum constant in enum class com.marklogic.flux.api.AuthenticationType
 
-
cloudApiKey(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
cloudApiKey(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
collections(String...) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
+
collections(String...) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
 
-
collections(String...) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
+
collections(String...) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
 
-
collections(String...) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
+
collections(String...) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
 
-
collectionsString(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
+
collectionsString(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
 
com.marklogic.flux.api - package com.marklogic.flux.api
@@ -235,1002 +185,893 @@

C

Flux class, which provides a static method corresponding to each command available in the Flux CLI.
-
COMMON - com.marklogic.flux.api.SslHostnameVerifier
+
COMMON - Enum constant in enum class com.marklogic.flux.api.SslHostnameVerifier
 
-
compressionType(CompressionType) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter.ReadXmlFilesOptions
+
compressionType(CompressionType) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter.ReadXmlFilesOptions
 
-
compressionType(CompressionType) - Method in interface com.marklogic.flux.api.GenericFilesExporter.WriteGenericFilesOptions
+
compressionType(CompressionType) - Method in interface com.marklogic.flux.api.GenericFilesExporter.WriteGenericFilesOptions
 
-
compressionType(CompressionType) - Method in interface com.marklogic.flux.api.GenericFilesImporter.ReadGenericFilesOptions
+
compressionType(CompressionType) - Method in interface com.marklogic.flux.api.GenericFilesImporter.ReadGenericFilesOptions
 
-
compressionType(CompressionType) - Method in interface com.marklogic.flux.api.RdfFilesImporter.ReadRdfFilesOptions
+
compressionType(CompressionType) - Method in interface com.marklogic.flux.api.RdfFilesImporter.ReadRdfFilesOptions
 
-
CompressionType - Enum in com.marklogic.flux.api
+
CompressionType - Enum Class in com.marklogic.flux.api
 
-
connection(Consumer<ConnectionOptions>) - Method in interface com.marklogic.flux.api.Executor
+
connection(Consumer<ConnectionOptions>) - Method in interface com.marklogic.flux.api.Executor
Configure a connection to MarkLogic.
-
ConnectionOptions - Interface in com.marklogic.flux.api
+
ConnectionOptions - Interface in com.marklogic.flux.api
 
-
connectionString(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
connectionString(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
connectionString(String) - Method in interface com.marklogic.flux.api.Executor
+
connectionString(String) - Method in interface com.marklogic.flux.api.Executor
Convenience for the common use case of configuring a MarkLogic connection via a connection string.
-
connectionType(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
connectionType(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
copyDocuments() - Static method in class com.marklogic.flux.api.Flux
+
copyDocuments() - Static method in class com.marklogic.flux.api.Flux
 
-
count() - Method in interface com.marklogic.flux.api.Executor
+
count() - Method in interface com.marklogic.flux.api.Executor
 
-
CustomDocumentsExporter - Interface in com.marklogic.flux.api
+
CustomDocumentsExporter - Interface in com.marklogic.flux.api
Read documents from MarkLogic and write them using a custom Spark connector or data source.
-
customExportDocuments() - Static method in class com.marklogic.flux.api.Flux
+
customExportDocuments() - Static method in class com.marklogic.flux.api.Flux
 
-
customExportRows() - Static method in class com.marklogic.flux.api.Flux
+
customExportRows() - Static method in class com.marklogic.flux.api.Flux
 
-
CustomExportWriteOptions - Interface in com.marklogic.flux.api
+
CustomExportWriteOptions - Interface in com.marklogic.flux.api
 
-
customImport() - Static method in class com.marklogic.flux.api.Flux
+
customImport() - Static method in class com.marklogic.flux.api.Flux
 
-
CustomImporter - Interface in com.marklogic.flux.api
+
CustomImporter - Interface in com.marklogic.flux.api
Read data via a custom Spark connector or data source and write JSON or XML documents to MarkLogic.
-
CustomImporter.CustomReadOptions - Interface in com.marklogic.flux.api
+
CustomImporter.CustomReadOptions - Interface in com.marklogic.flux.api
 
-
CustomRowsExporter - Interface in com.marklogic.flux.api
+
CustomRowsExporter - Interface in com.marklogic.flux.api
Read rows from MarkLogic and write them using a custom Spark connector or data source.
- - - -

D

-
-
database(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
-
 
-
DelimitedFilesExporter - Interface in com.marklogic.flux.api
+

D

+
+
database(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
 
+
DelimitedFilesExporter - Interface in com.marklogic.flux.api
Read rows via Optic from MarkLogic and write them to delimited text files on a local filesystem, HDFS, or S3 using Spark's CSV support.
-
DelimitedFilesExporter.WriteDelimitedFilesOptions - Interface in com.marklogic.flux.api
+
DelimitedFilesExporter.WriteDelimitedFilesOptions - Interface in com.marklogic.flux.api
 
-
DelimitedFilesImporter - Interface in com.marklogic.flux.api
+
DelimitedFilesImporter - Interface in com.marklogic.flux.api
Read delimited text files from local, HDFS, and S3 locations using Spark's CSV support, and write JSON or XML documents to MarkLogic.
-
DelimitedFilesImporter.ReadDelimitedFilesOptions - Interface in com.marklogic.flux.api
+
DelimitedFilesImporter.ReadDelimitedFilesOptions - Interface in com.marklogic.flux.api
 
-
delimiter(String) - Method in interface com.marklogic.flux.api.DelimitedFilesImporter.ReadDelimitedFilesOptions
+
delimiter(String) - Method in interface com.marklogic.flux.api.DelimitedFilesImporter.ReadDelimitedFilesOptions
 
-
DIGEST - com.marklogic.flux.api.AuthenticationType
+
DIGEST - Enum constant in enum class com.marklogic.flux.api.AuthenticationType
 
-
directory(String) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
+
directory(String) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
 
-
directory(String) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
+
directory(String) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
 
-
disableAggregationPushDown(boolean) - Method in interface com.marklogic.flux.api.ReadRowsOptions
+
disableAggregationPushDown(boolean) - Method in interface com.marklogic.flux.api.ReadRowsOptions
 
-
disableGzippedResponses(boolean) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
disableGzippedResponses(boolean) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
DocumentCopier - Interface in com.marklogic.flux.api
+
DocumentCopier - Interface in com.marklogic.flux.api
Copy documents from one database to another database, which can also be the originating database.
-
DocumentCopier.CopyReadDocumentsOptions - Interface in com.marklogic.flux.api
+
DocumentCopier.CopyReadDocumentsOptions - Interface in com.marklogic.flux.api
 
-
documentType(GenericFilesImporter.DocumentType) - Method in interface com.marklogic.flux.api.GenericFilesImporter.WriteGenericDocumentsOptions
+
documentType(GenericFilesImporter.DocumentType) - Method in interface com.marklogic.flux.api.GenericFilesImporter.WriteGenericDocumentsOptions
 
-
driver(String) - Method in interface com.marklogic.flux.api.JdbcOptions
+
driver(String) - Method in interface com.marklogic.flux.api.JdbcOptions
 
- - - -

E

-
-
element(String) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter.ReadXmlFilesOptions
+

E

+
+
element(String) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter.ReadXmlFilesOptions
 
-
encoding(String) - Method in interface com.marklogic.flux.api.AggregateJsonFilesImporter.ReadJsonFilesOptions
+
encoding(String) - Method in interface com.marklogic.flux.api.AggregateJsonFilesImporter.ReadJsonFilesOptions
 
-
encoding(String) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter.ReadXmlFilesOptions
+
encoding(String) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter.ReadXmlFilesOptions
 
-
encoding(String) - Method in interface com.marklogic.flux.api.ArchiveFilesExporter.WriteArchiveFilesOptions
+
encoding(String) - Method in interface com.marklogic.flux.api.ArchiveFilesExporter.WriteArchiveFilesOptions
 
-
encoding(String) - Method in interface com.marklogic.flux.api.ArchiveFilesImporter.ReadArchiveFilesOptions
+
encoding(String) - Method in interface com.marklogic.flux.api.ArchiveFilesImporter.ReadArchiveFilesOptions
 
-
encoding(String) - Method in interface com.marklogic.flux.api.DelimitedFilesExporter.WriteDelimitedFilesOptions
+
encoding(String) - Method in interface com.marklogic.flux.api.DelimitedFilesExporter.WriteDelimitedFilesOptions
 
-
encoding(String) - Method in interface com.marklogic.flux.api.DelimitedFilesImporter.ReadDelimitedFilesOptions
+
encoding(String) - Method in interface com.marklogic.flux.api.DelimitedFilesImporter.ReadDelimitedFilesOptions
 
-
encoding(String) - Method in interface com.marklogic.flux.api.GenericFilesExporter.WriteGenericFilesOptions
+
encoding(String) - Method in interface com.marklogic.flux.api.GenericFilesExporter.WriteGenericFilesOptions
 
-
encoding(String) - Method in interface com.marklogic.flux.api.GenericFilesImporter.ReadGenericFilesOptions
+
encoding(String) - Method in interface com.marklogic.flux.api.GenericFilesImporter.ReadGenericFilesOptions
 
-
encoding(String) - Method in interface com.marklogic.flux.api.JsonLinesFilesExporter.WriteJsonLinesFilesOptions
+
encoding(String) - Method in interface com.marklogic.flux.api.JsonLinesFilesExporter.WriteJsonLinesFilesOptions
 
-
encoding(String) - Method in interface com.marklogic.flux.api.MlcpArchiveFilesImporter.ReadMlcpArchiveFilesOptions
+
encoding(String) - Method in interface com.marklogic.flux.api.MlcpArchiveFilesImporter.ReadMlcpArchiveFilesOptions
 
-
ERRORIFEXISTS - com.marklogic.flux.api.SaveMode
+
ERRORIFEXISTS - Enum constant in enum class com.marklogic.flux.api.SaveMode
 
-
execute() - Method in interface com.marklogic.flux.api.Executor
+
execute() - Method in interface com.marklogic.flux.api.Executor
Execute this executor instance with a default Spark session.
-
Executor<T extends Executor> - Interface in com.marklogic.flux.api
+
Executor<T extends Executor> - Interface in com.marklogic.flux.api
Top-level interface for objects that can execute some type of batch process involving a connection to MarkLogic.
-
exportArchiveFiles() - Static method in class com.marklogic.flux.api.Flux
+
exportArchiveFiles() - Static method in class com.marklogic.flux.api.Flux
 
-
exportAvroFiles() - Static method in class com.marklogic.flux.api.Flux
+
exportAvroFiles() - Static method in class com.marklogic.flux.api.Flux
 
-
exportDelimitedFiles() - Static method in class com.marklogic.flux.api.Flux
+
exportDelimitedFiles() - Static method in class com.marklogic.flux.api.Flux
 
-
exportGenericFiles() - Static method in class com.marklogic.flux.api.Flux
+
exportGenericFiles() - Static method in class com.marklogic.flux.api.Flux
 
-
exportJdbc() - Static method in class com.marklogic.flux.api.Flux
+
exportJdbc() - Static method in class com.marklogic.flux.api.Flux
 
-
exportJsonLinesFiles() - Static method in class com.marklogic.flux.api.Flux
+
exportJsonLinesFiles() - Static method in class com.marklogic.flux.api.Flux
 
-
exportOrcFiles() - Static method in class com.marklogic.flux.api.Flux
+
exportOrcFiles() - Static method in class com.marklogic.flux.api.Flux
 
-
exportParquetFiles() - Static method in class com.marklogic.flux.api.Flux
+
exportParquetFiles() - Static method in class com.marklogic.flux.api.Flux
 
-
exportRdfFiles() - Static method in class com.marklogic.flux.api.Flux
+
exportRdfFiles() - Static method in class com.marklogic.flux.api.Flux
 
-
externalVariableDelimiter(String) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
+
externalVariableDelimiter(String) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
 
-
externalVariableName(String) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
+
externalVariableName(String) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
 
- - - -

F

-
-
failedDocumentsPath(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
+

F

+
+
failedDocumentsPath(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
 
-
fileCount(int) - Method in interface com.marklogic.flux.api.WriteFilesOptions
+
fileCount(int) - Method in interface com.marklogic.flux.api.WriteFilesOptions
 
-
filter(String) - Method in interface com.marklogic.flux.api.ReadFilesOptions
+
filter(String) - Method in interface com.marklogic.flux.api.ReadFilesOptions
 
-
Flux - Class in com.marklogic.flux.api
+
Flux - Class in com.marklogic.flux.api
Entry point for executing Flux commands via the API.
-
FluxException - Exception in com.marklogic.flux.api
+
FluxException - Exception in com.marklogic.flux.api
Wraps any exception not thrown by the MarkLogic Spark connector so that API users are not exposed directly to Spark exceptions.
-
FluxException(String) - Constructor for exception com.marklogic.flux.api.FluxException
+
FluxException(String) - Constructor for exception com.marklogic.flux.api.FluxException
 
-
FluxException(String, Throwable) - Constructor for exception com.marklogic.flux.api.FluxException
+
FluxException(String, Throwable) - Constructor for exception com.marklogic.flux.api.FluxException
 
-
FluxException(Throwable) - Constructor for exception com.marklogic.flux.api.FluxException
+
FluxException(Throwable) - Constructor for exception com.marklogic.flux.api.FluxException
 
-
format(String) - Method in interface com.marklogic.flux.api.RdfFilesExporter.WriteRdfFilesOptions
+
format(String) - Method in interface com.marklogic.flux.api.RdfFilesExporter.WriteRdfFilesOptions
 
-
from(String) - Method in interface com.marklogic.flux.api.AvroFilesExporter
+
from(String) - Method in interface com.marklogic.flux.api.AvroFilesExporter
 
-
from(String) - Method in interface com.marklogic.flux.api.CustomRowsExporter
+
from(String) - Method in interface com.marklogic.flux.api.CustomRowsExporter
 
-
from(String) - Method in interface com.marklogic.flux.api.DelimitedFilesExporter
+
from(String) - Method in interface com.marklogic.flux.api.DelimitedFilesExporter
 
-
from(String) - Method in interface com.marklogic.flux.api.JdbcExporter
+
from(String) - Method in interface com.marklogic.flux.api.JdbcExporter
 
-
from(String) - Method in interface com.marklogic.flux.api.JsonLinesFilesExporter
+
from(String) - Method in interface com.marklogic.flux.api.JsonLinesFilesExporter
 
-
from(String) - Method in interface com.marklogic.flux.api.OrcFilesExporter
+
from(String) - Method in interface com.marklogic.flux.api.OrcFilesExporter
 
-
from(String) - Method in interface com.marklogic.flux.api.ParquetFilesExporter
+
from(String) - Method in interface com.marklogic.flux.api.ParquetFilesExporter
 
-
from(String...) - Method in interface com.marklogic.flux.api.AggregateJsonFilesImporter
+
from(String...) - Method in interface com.marklogic.flux.api.AggregateJsonFilesImporter
 
-
from(String...) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter
+
from(String...) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter
 
-
from(String...) - Method in interface com.marklogic.flux.api.ArchiveFilesImporter
+
from(String...) - Method in interface com.marklogic.flux.api.ArchiveFilesImporter
 
-
from(String...) - Method in interface com.marklogic.flux.api.AvroFilesImporter
+
from(String...) - Method in interface com.marklogic.flux.api.AvroFilesImporter
 
-
from(String...) - Method in interface com.marklogic.flux.api.DelimitedFilesImporter
+
from(String...) - Method in interface com.marklogic.flux.api.DelimitedFilesImporter
 
-
from(String...) - Method in interface com.marklogic.flux.api.GenericFilesImporter
+
from(String...) - Method in interface com.marklogic.flux.api.GenericFilesImporter
 
-
from(String...) - Method in interface com.marklogic.flux.api.MlcpArchiveFilesImporter
+
from(String...) - Method in interface com.marklogic.flux.api.MlcpArchiveFilesImporter
 
-
from(String...) - Method in interface com.marklogic.flux.api.OrcFilesImporter
+
from(String...) - Method in interface com.marklogic.flux.api.OrcFilesImporter
 
-
from(String...) - Method in interface com.marklogic.flux.api.ParquetFilesImporter
+
from(String...) - Method in interface com.marklogic.flux.api.ParquetFilesImporter
 
-
from(String...) - Method in interface com.marklogic.flux.api.RdfFilesImporter
+
from(String...) - Method in interface com.marklogic.flux.api.RdfFilesImporter
 
-
from(Consumer<AggregateJsonFilesImporter.ReadJsonFilesOptions>) - Method in interface com.marklogic.flux.api.AggregateJsonFilesImporter
+
from(Consumer<AggregateJsonFilesImporter.ReadJsonFilesOptions>) - Method in interface com.marklogic.flux.api.AggregateJsonFilesImporter
 
-
from(Consumer<AggregateXmlFilesImporter.ReadXmlFilesOptions>) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter
+
from(Consumer<AggregateXmlFilesImporter.ReadXmlFilesOptions>) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter
 
-
from(Consumer<ArchiveFilesExporter.ReadArchiveDocumentOptions>) - Method in interface com.marklogic.flux.api.ArchiveFilesExporter
+
from(Consumer<ArchiveFilesExporter.ReadArchiveDocumentOptions>) - Method in interface com.marklogic.flux.api.ArchiveFilesExporter
 
-
from(Consumer<ArchiveFilesImporter.ReadArchiveFilesOptions>) - Method in interface com.marklogic.flux.api.ArchiveFilesImporter
+
from(Consumer<ArchiveFilesImporter.ReadArchiveFilesOptions>) - Method in interface com.marklogic.flux.api.ArchiveFilesImporter
 
-
from(Consumer<CustomImporter.CustomReadOptions>) - Method in interface com.marklogic.flux.api.CustomImporter
+
from(Consumer<CustomImporter.CustomReadOptions>) - Method in interface com.marklogic.flux.api.CustomImporter
 
-
from(Consumer<DelimitedFilesImporter.ReadDelimitedFilesOptions>) - Method in interface com.marklogic.flux.api.DelimitedFilesImporter
+
from(Consumer<DelimitedFilesImporter.ReadDelimitedFilesOptions>) - Method in interface com.marklogic.flux.api.DelimitedFilesImporter
 
-
from(Consumer<DocumentCopier.CopyReadDocumentsOptions>) - Method in interface com.marklogic.flux.api.DocumentCopier
+
from(Consumer<DocumentCopier.CopyReadDocumentsOptions>) - Method in interface com.marklogic.flux.api.DocumentCopier
 
-
from(Consumer<GenericFilesImporter.ReadGenericFilesOptions>) - Method in interface com.marklogic.flux.api.GenericFilesImporter
+
from(Consumer<GenericFilesImporter.ReadGenericFilesOptions>) - Method in interface com.marklogic.flux.api.GenericFilesImporter
 
-
from(Consumer<JdbcImporter.ReadJdbcOptions>) - Method in interface com.marklogic.flux.api.JdbcImporter
+
from(Consumer<JdbcImporter.ReadJdbcOptions>) - Method in interface com.marklogic.flux.api.JdbcImporter
 
-
from(Consumer<MlcpArchiveFilesImporter.ReadMlcpArchiveFilesOptions>) - Method in interface com.marklogic.flux.api.MlcpArchiveFilesImporter
+
from(Consumer<MlcpArchiveFilesImporter.ReadMlcpArchiveFilesOptions>) - Method in interface com.marklogic.flux.api.MlcpArchiveFilesImporter
 
-
from(Consumer<RdfFilesExporter.ReadTriplesDocumentsOptions>) - Method in interface com.marklogic.flux.api.RdfFilesExporter
+
from(Consumer<RdfFilesExporter.ReadTriplesDocumentsOptions>) - Method in interface com.marklogic.flux.api.RdfFilesExporter
 
-
from(Consumer<RdfFilesImporter.ReadRdfFilesOptions>) - Method in interface com.marklogic.flux.api.RdfFilesImporter
+
from(Consumer<RdfFilesImporter.ReadRdfFilesOptions>) - Method in interface com.marklogic.flux.api.RdfFilesImporter
 
-
from(Consumer<ReadDocumentsOptions<? extends ReadDocumentsOptions>>) - Method in interface com.marklogic.flux.api.CustomDocumentsExporter
+
from(Consumer<ReadDocumentsOptions<? extends ReadDocumentsOptions>>) - Method in interface com.marklogic.flux.api.CustomDocumentsExporter
 
-
from(Consumer<ReadDocumentsOptions<? extends ReadDocumentsOptions>>) - Method in interface com.marklogic.flux.api.GenericFilesExporter
+
from(Consumer<ReadDocumentsOptions<? extends ReadDocumentsOptions>>) - Method in interface com.marklogic.flux.api.GenericFilesExporter
 
-
from(Consumer<ReadRowsOptions>) - Method in interface com.marklogic.flux.api.AvroFilesExporter
+
from(Consumer<ReadRowsOptions>) - Method in interface com.marklogic.flux.api.AvroFilesExporter
 
-
from(Consumer<ReadRowsOptions>) - Method in interface com.marklogic.flux.api.CustomRowsExporter
+
from(Consumer<ReadRowsOptions>) - Method in interface com.marklogic.flux.api.CustomRowsExporter
 
-
from(Consumer<ReadRowsOptions>) - Method in interface com.marklogic.flux.api.DelimitedFilesExporter
+
from(Consumer<ReadRowsOptions>) - Method in interface com.marklogic.flux.api.DelimitedFilesExporter
 
-
from(Consumer<ReadRowsOptions>) - Method in interface com.marklogic.flux.api.JdbcExporter
+
from(Consumer<ReadRowsOptions>) - Method in interface com.marklogic.flux.api.JdbcExporter
 
-
from(Consumer<ReadRowsOptions>) - Method in interface com.marklogic.flux.api.JsonLinesFilesExporter
+
from(Consumer<ReadRowsOptions>) - Method in interface com.marklogic.flux.api.JsonLinesFilesExporter
 
-
from(Consumer<ReadRowsOptions>) - Method in interface com.marklogic.flux.api.OrcFilesExporter
+
from(Consumer<ReadRowsOptions>) - Method in interface com.marklogic.flux.api.OrcFilesExporter
 
-
from(Consumer<ReadRowsOptions>) - Method in interface com.marklogic.flux.api.ParquetFilesExporter
+
from(Consumer<ReadRowsOptions>) - Method in interface com.marklogic.flux.api.ParquetFilesExporter
 
-
from(Consumer<ReadTabularFilesOptions>) - Method in interface com.marklogic.flux.api.AvroFilesImporter
+
from(Consumer<ReadTabularFilesOptions>) - Method in interface com.marklogic.flux.api.AvroFilesImporter
 
-
from(Consumer<ReadTabularFilesOptions>) - Method in interface com.marklogic.flux.api.OrcFilesImporter
+
from(Consumer<ReadTabularFilesOptions>) - Method in interface com.marklogic.flux.api.OrcFilesImporter
 
-
from(Consumer<ReadTabularFilesOptions>) - Method in interface com.marklogic.flux.api.ParquetFilesImporter
+
from(Consumer<ReadTabularFilesOptions>) - Method in interface com.marklogic.flux.api.ParquetFilesImporter
 
-
from(Consumer<Reprocessor.ReadOptions>) - Method in interface com.marklogic.flux.api.Reprocessor
+
from(Consumer<Reprocessor.ReadOptions>) - Method in interface com.marklogic.flux.api.Reprocessor
 
- - - -

G

-
-
GenericFilesExporter - Interface in com.marklogic.flux.api
+

G

+
+
GenericFilesExporter - Interface in com.marklogic.flux.api
Read documents from MarkLogic and write them to a local filesystem, HDFS, or S3.
-
GenericFilesExporter.WriteGenericFilesOptions - Interface in com.marklogic.flux.api
+
GenericFilesExporter.WriteGenericFilesOptions - Interface in com.marklogic.flux.api
 
-
GenericFilesImporter - Interface in com.marklogic.flux.api
+
GenericFilesImporter - Interface in com.marklogic.flux.api
Read local, HDFS, and S3 files and write the contents of each file as a document in MarkLogic.
-
GenericFilesImporter.DocumentType - Enum in com.marklogic.flux.api
+
GenericFilesImporter.DocumentType - Enum Class in com.marklogic.flux.api
 
-
GenericFilesImporter.ReadGenericFilesOptions - Interface in com.marklogic.flux.api
+
GenericFilesImporter.ReadGenericFilesOptions - Interface in com.marklogic.flux.api
 
-
GenericFilesImporter.WriteGenericDocumentsOptions - Interface in com.marklogic.flux.api
+
GenericFilesImporter.WriteGenericDocumentsOptions - Interface in com.marklogic.flux.api
 
-
graph(String) - Method in interface com.marklogic.flux.api.RdfFilesImporter.WriteTriplesDocumentsOptions
+
graph(String) - Method in interface com.marklogic.flux.api.RdfFilesImporter.WriteTriplesDocumentsOptions
 
-
graphOverride(String) - Method in interface com.marklogic.flux.api.RdfFilesExporter.WriteRdfFilesOptions
+
graphOverride(String) - Method in interface com.marklogic.flux.api.RdfFilesExporter.WriteRdfFilesOptions
 
-
graphOverride(String) - Method in interface com.marklogic.flux.api.RdfFilesImporter.WriteTriplesDocumentsOptions
+
graphOverride(String) - Method in interface com.marklogic.flux.api.RdfFilesImporter.WriteTriplesDocumentsOptions
 
-
graphs(String...) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
+
graphs(String...) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
 
-
groupBy(String) - Method in interface com.marklogic.flux.api.DelimitedFilesImporter.ReadDelimitedFilesOptions
+
groupBy(String) - Method in interface com.marklogic.flux.api.DelimitedFilesImporter.ReadDelimitedFilesOptions
 
-
groupBy(String) - Method in interface com.marklogic.flux.api.JdbcImporter.ReadJdbcOptions
+
groupBy(String) - Method in interface com.marklogic.flux.api.JdbcImporter.ReadJdbcOptions
 
-
groupBy(String) - Method in interface com.marklogic.flux.api.ReadTabularFilesOptions
+
groupBy(String) - Method in interface com.marklogic.flux.api.ReadTabularFilesOptions
 
-
gzip() - Method in interface com.marklogic.flux.api.RdfFilesExporter.WriteRdfFilesOptions
+
gzip() - Method in interface com.marklogic.flux.api.RdfFilesExporter.WriteRdfFilesOptions
 
-
GZIP - com.marklogic.flux.api.CompressionType
+
GZIP - Enum constant in enum class com.marklogic.flux.api.CompressionType
 
- - - -

H

-
-
host(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+

H

+
+
host(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
- - - -

I

-
-
IGNORE - com.marklogic.flux.api.SaveMode
+

I

+
+
IGNORE - Enum constant in enum class com.marklogic.flux.api.SaveMode
 
-
ignoreNullFields(boolean) - Method in interface com.marklogic.flux.api.WriteStructuredDocumentsOptions
+
ignoreNullFields(boolean) - Method in interface com.marklogic.flux.api.WriteStructuredDocumentsOptions
 
-
importAggregateJsonFiles() - Static method in class com.marklogic.flux.api.Flux
+
importAggregateJsonFiles() - Static method in class com.marklogic.flux.api.Flux
 
-
importAggregateXmlFiles() - Static method in class com.marklogic.flux.api.Flux
+
importAggregateXmlFiles() - Static method in class com.marklogic.flux.api.Flux
 
-
importArchiveFiles() - Static method in class com.marklogic.flux.api.Flux
+
importArchiveFiles() - Static method in class com.marklogic.flux.api.Flux
 
-
importAvroFiles() - Static method in class com.marklogic.flux.api.Flux
+
importAvroFiles() - Static method in class com.marklogic.flux.api.Flux
 
-
importDelimitedFiles() - Static method in class com.marklogic.flux.api.Flux
+
importDelimitedFiles() - Static method in class com.marklogic.flux.api.Flux
 
-
importGenericFiles() - Static method in class com.marklogic.flux.api.Flux
+
importGenericFiles() - Static method in class com.marklogic.flux.api.Flux
 
-
importJdbc() - Static method in class com.marklogic.flux.api.Flux
+
importJdbc() - Static method in class com.marklogic.flux.api.Flux
 
-
importMlcpArchiveFiles() - Static method in class com.marklogic.flux.api.Flux
+
importMlcpArchiveFiles() - Static method in class com.marklogic.flux.api.Flux
 
-
importOrcFiles() - Static method in class com.marklogic.flux.api.Flux
+
importOrcFiles() - Static method in class com.marklogic.flux.api.Flux
 
-
importParquetFiles() - Static method in class com.marklogic.flux.api.Flux
+
importParquetFiles() - Static method in class com.marklogic.flux.api.Flux
 
-
importRdfFiles() - Static method in class com.marklogic.flux.api.Flux
+
importRdfFiles() - Static method in class com.marklogic.flux.api.Flux
 
-
invoke(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
+
invoke(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
 
-
invoke(String) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
+
invoke(String) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
 
- - - -

J

-
-
javascript(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
+

J

+
+
javascript(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
 
-
javascript(String) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
+
javascript(String) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
 
-
javascriptFile(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
+
javascriptFile(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
 
-
javascriptFile(String) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
+
javascriptFile(String) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
 
-
JdbcExporter - Interface in com.marklogic.flux.api
+
JdbcExporter - Interface in com.marklogic.flux.api
Read rows via Optic from MarkLogic and write them to a table using Spark's JDBC support.
-
JdbcExporter.WriteRowsOptions - Interface in com.marklogic.flux.api
+
JdbcExporter.WriteRowsOptions - Interface in com.marklogic.flux.api
 
-
JdbcImporter - Interface in com.marklogic.flux.api
+
JdbcImporter - Interface in com.marklogic.flux.api
Read rows using Spark's JDBC support and write JSON or XML documents to MarkLogic.
-
JdbcImporter.ReadJdbcOptions - Interface in com.marklogic.flux.api
+
JdbcImporter.ReadJdbcOptions - Interface in com.marklogic.flux.api
 
-
JdbcOptions<T extends JdbcOptions> - Interface in com.marklogic.flux.api
+
JdbcOptions<T extends JdbcOptions> - Interface in com.marklogic.flux.api
 
-
JSON - com.marklogic.flux.api.GenericFilesImporter.DocumentType
+
JSON - Enum constant in enum class com.marklogic.flux.api.GenericFilesImporter.DocumentType
 
-
jsonLines() - Method in interface com.marklogic.flux.api.AggregateJsonFilesImporter.ReadJsonFilesOptions
+
jsonLines() - Method in interface com.marklogic.flux.api.AggregateJsonFilesImporter.ReadJsonFilesOptions
Call this to read JSON Lines files.
-
jsonLines(boolean) - Method in interface com.marklogic.flux.api.AggregateJsonFilesImporter.ReadJsonFilesOptions
+
jsonLines(boolean) - Method in interface com.marklogic.flux.api.AggregateJsonFilesImporter.ReadJsonFilesOptions
-
Deprecated, for removal: This API element is subject to removal in a future version. -
since 1.1.2; use jsonLines() instead.
+
Deprecated, for removal: This API element is subject to removal in a future version. +
since 1.1.2; use jsonLines() instead.
-
JsonLinesFilesExporter - Interface in com.marklogic.flux.api
+
JsonLinesFilesExporter - Interface in com.marklogic.flux.api
Read rows via Optic from MarkLogic and write them to JSON Lines files on a local filesystem, HDFS, or S3 using Spark's JSON support.
-
JsonLinesFilesExporter.WriteJsonLinesFilesOptions - Interface in com.marklogic.flux.api
+
JsonLinesFilesExporter.WriteJsonLinesFilesOptions - Interface in com.marklogic.flux.api
 
-
jsonLinesRaw() - Method in interface com.marklogic.flux.api.AggregateJsonFilesImporter.ReadJsonFilesOptions
+
jsonLinesRaw() - Method in interface com.marklogic.flux.api.AggregateJsonFilesImporter.ReadJsonFilesOptions
Call this to read JSON Lines files "as is", without any alteration to the documents associated with each line.
-
jsonRootName(String) - Method in interface com.marklogic.flux.api.WriteStructuredDocumentsOptions
+
jsonRootName(String) - Method in interface com.marklogic.flux.api.WriteStructuredDocumentsOptions
 
- - - -

K

-
-
KERBEROS - com.marklogic.flux.api.AuthenticationType
+

K

+
+
KERBEROS - Enum constant in enum class com.marklogic.flux.api.AuthenticationType
 
-
kerberosPrincipal(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
kerberosPrincipal(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
keyStoreAlgorithm(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
keyStoreAlgorithm(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
keyStorePassword(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
keyStorePassword(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
keyStorePath(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
keyStorePath(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
keyStoreType(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
keyStoreType(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
- - - -

L

-
-
limit(int) - Method in interface com.marklogic.flux.api.Executor
+

L

+
+
limit(int) - Method in interface com.marklogic.flux.api.Executor
Limit the number of records read from the executor's data source.
-
logProgress(int) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
+
logProgress(int) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
 
-
logProgress(int) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
+
logProgress(int) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
 
-
logProgress(int) - Method in interface com.marklogic.flux.api.ReadRowsOptions
+
logProgress(int) - Method in interface com.marklogic.flux.api.ReadRowsOptions
 
-
logProgress(int) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
+
logProgress(int) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
 
-
logProgress(int) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
+
logProgress(int) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
 
-
logProgress(int) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
+
logProgress(int) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
 
- - - -

M

-
-
MlcpArchiveFilesImporter - Interface in com.marklogic.flux.api
+

M

+
+
MlcpArchiveFilesImporter - Interface in com.marklogic.flux.api
Read local, HDFS, and S3 archive files written by MLCP and write the documents in each archive to MarkLogic.
-
MlcpArchiveFilesImporter.ReadMlcpArchiveFilesOptions - Interface in com.marklogic.flux.api
+
MlcpArchiveFilesImporter.ReadMlcpArchiveFilesOptions - Interface in com.marklogic.flux.api
 
- - - -

N

-
-
namespace(String) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter.ReadXmlFilesOptions
-
 
-
noSnapshot() - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
+

N

+
+
namespace(String) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter.ReadXmlFilesOptions
+
 
+
noSnapshot() - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
Read documents at multiple points in time, as opposed to using a consistent snapshot.
-
noSnapshot() - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
+
noSnapshot() - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
Read documents at multiple points in time, as opposed to using a consistent snapshot.
- - - -

O

-
-
opticQuery(String) - Method in interface com.marklogic.flux.api.ReadRowsOptions
+

O

+
+
opticQuery(String) - Method in interface com.marklogic.flux.api.ReadRowsOptions
 
-
options(String) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
+
options(String) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
 
-
options(String) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
+
options(String) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
 
-
OrcFilesExporter - Interface in com.marklogic.flux.api
+
OrcFilesExporter - Interface in com.marklogic.flux.api
Read rows via Optic from MarkLogic and write them to ORC files on a local filesystem, HDFS, or S3 using Spark's ORC support.
-
OrcFilesImporter - Interface in com.marklogic.flux.api
+
OrcFilesImporter - Interface in com.marklogic.flux.api
Read ORC files from local, HDFS, and S3 locations using Spark's ORC support, and write JSON or XML documents to MarkLogic.
-
outputConnection(Consumer<ConnectionOptions>) - Method in interface com.marklogic.flux.api.DocumentCopier
+
outputConnection(Consumer<ConnectionOptions>) - Method in interface com.marklogic.flux.api.DocumentCopier
 
-
outputConnectionString(String) - Method in interface com.marklogic.flux.api.DocumentCopier
+
outputConnectionString(String) - Method in interface com.marklogic.flux.api.DocumentCopier
 
-
OVERWRITE - com.marklogic.flux.api.SaveMode
+
OVERWRITE - Enum constant in enum class com.marklogic.flux.api.SaveMode
 
- - - -

P

-
-
ParquetFilesExporter - Interface in com.marklogic.flux.api
+

P

+
+
ParquetFilesExporter - Interface in com.marklogic.flux.api
Read rows via Optic from MarkLogic and write them to Parquet files on a local filesystem, HDFS, or S3 using Spark's Parquet support.
-
ParquetFilesImporter - Interface in com.marklogic.flux.api
+
ParquetFilesImporter - Interface in com.marklogic.flux.api
Read Parquet files from local, HDFS, and S3 locations using Spark's Parquet support, and write JSON or XML documents to MarkLogic.
-
partitions(int) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter.ReadXmlFilesOptions
+
partitions(int) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter.ReadXmlFilesOptions
 
-
partitions(int) - Method in interface com.marklogic.flux.api.ArchiveFilesImporter.ReadArchiveFilesOptions
+
partitions(int) - Method in interface com.marklogic.flux.api.ArchiveFilesImporter.ReadArchiveFilesOptions
 
-
partitions(int) - Method in interface com.marklogic.flux.api.GenericFilesImporter.ReadGenericFilesOptions
+
partitions(int) - Method in interface com.marklogic.flux.api.GenericFilesImporter.ReadGenericFilesOptions
 
-
partitions(int) - Method in interface com.marklogic.flux.api.MlcpArchiveFilesImporter.ReadMlcpArchiveFilesOptions
+
partitions(int) - Method in interface com.marklogic.flux.api.MlcpArchiveFilesImporter.ReadMlcpArchiveFilesOptions
 
-
partitions(int) - Method in interface com.marklogic.flux.api.RdfFilesImporter.ReadRdfFilesOptions
+
partitions(int) - Method in interface com.marklogic.flux.api.RdfFilesImporter.ReadRdfFilesOptions
 
-
partitions(int) - Method in interface com.marklogic.flux.api.ReadRowsOptions
+
partitions(int) - Method in interface com.marklogic.flux.api.ReadRowsOptions
 
-
partitionsInvoke(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
+
partitionsInvoke(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
 
-
partitionsJavascript(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
+
partitionsJavascript(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
 
-
partitionsJavascriptFile(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
+
partitionsJavascriptFile(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
 
-
partitionsPerForest(int) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
+
partitionsPerForest(int) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
 
-
partitionsPerForest(int) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
+
partitionsPerForest(int) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
 
-
partitionsXquery(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
+
partitionsXquery(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
 
-
partitionsXqueryFile(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
+
partitionsXqueryFile(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
 
-
password(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
password(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
password(String) - Method in interface com.marklogic.flux.api.JdbcOptions
+
password(String) - Method in interface com.marklogic.flux.api.JdbcOptions
 
-
path(String) - Method in interface com.marklogic.flux.api.GenericFilesExporter.WriteGenericFilesOptions
+
path(String) - Method in interface com.marklogic.flux.api.GenericFilesExporter.WriteGenericFilesOptions
 
-
path(String) - Method in interface com.marklogic.flux.api.WriteFilesOptions
+
path(String) - Method in interface com.marklogic.flux.api.WriteFilesOptions
 
-
paths(String...) - Method in interface com.marklogic.flux.api.ReadFilesOptions
+
paths(String...) - Method in interface com.marklogic.flux.api.ReadFilesOptions
 
-
permissionsString(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
+
permissionsString(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
 
-
port(int) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
port(int) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
prettyPrint(boolean) - Method in interface com.marklogic.flux.api.GenericFilesExporter.WriteGenericFilesOptions
+
prettyPrint(boolean) - Method in interface com.marklogic.flux.api.GenericFilesExporter.WriteGenericFilesOptions
 
- - - -

Q

-
-
query(String) - Method in interface com.marklogic.flux.api.JdbcImporter.ReadJdbcOptions
+

Q

+
+
query(String) - Method in interface com.marklogic.flux.api.JdbcImporter.ReadJdbcOptions
 
-
query(String) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
+
query(String) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
 
-
query(String) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
+
query(String) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
 
- - - -

R

-
-
RdfFilesExporter - Interface in com.marklogic.flux.api
+

R

+
+
RdfFilesExporter - Interface in com.marklogic.flux.api
Read triples from MarkLogic and write them to a local filesystem, HDFS, or S3.
-
RdfFilesExporter.ReadTriplesDocumentsOptions - Interface in com.marklogic.flux.api
+
RdfFilesExporter.ReadTriplesDocumentsOptions - Interface in com.marklogic.flux.api
 
-
RdfFilesExporter.WriteRdfFilesOptions - Interface in com.marklogic.flux.api
+
RdfFilesExporter.WriteRdfFilesOptions - Interface in com.marklogic.flux.api
 
-
RdfFilesImporter - Interface in com.marklogic.flux.api
+
RdfFilesImporter - Interface in com.marklogic.flux.api
Read RDF data from local, HDFS, and S3 files and write the data as managed triples documents in MarkLogic.
-
RdfFilesImporter.ReadRdfFilesOptions - Interface in com.marklogic.flux.api
+
RdfFilesImporter.ReadRdfFilesOptions - Interface in com.marklogic.flux.api
 
-
RdfFilesImporter.WriteTriplesDocumentsOptions - Interface in com.marklogic.flux.api
+
RdfFilesImporter.WriteTriplesDocumentsOptions - Interface in com.marklogic.flux.api
 
-
ReadDocumentsOptions<T extends ReadDocumentsOptions> - Interface in com.marklogic.flux.api
+
ReadDocumentsOptions<T extends ReadDocumentsOptions> - Interface in com.marklogic.flux.api
 
-
ReadFilesOptions<T extends ReadFilesOptions> - Interface in com.marklogic.flux.api
+
ReadFilesOptions<T extends ReadFilesOptions> - Interface in com.marklogic.flux.api
 
-
ReadRowsOptions - Interface in com.marklogic.flux.api
+
ReadRowsOptions - Interface in com.marklogic.flux.api
 
-
ReadTabularFilesOptions - Interface in com.marklogic.flux.api
+
ReadTabularFilesOptions - Interface in com.marklogic.flux.api
For objects that can import tabular files, where the data source supports additional options that do not have dedicated methods in the importer interface.
-
recursiveFileLookup(boolean) - Method in interface com.marklogic.flux.api.ReadFilesOptions
+
recursiveFileLookup(boolean) - Method in interface com.marklogic.flux.api.ReadFilesOptions
 
-
reprocess() - Static method in class com.marklogic.flux.api.Flux
+
reprocess() - Static method in class com.marklogic.flux.api.Flux
 
-
Reprocessor - Interface in com.marklogic.flux.api
+
Reprocessor - Interface in com.marklogic.flux.api
Read data from MarkLogic via custom code and reprocess it via custom code.
-
Reprocessor.ReadOptions - Interface in com.marklogic.flux.api
+
Reprocessor.ReadOptions - Interface in com.marklogic.flux.api
 
-
Reprocessor.WriteOptions - Interface in com.marklogic.flux.api
+
Reprocessor.WriteOptions - Interface in com.marklogic.flux.api
 
- - - -

S

-
-
s3AccessKeyId(String) - Method in interface com.marklogic.flux.api.CustomExportWriteOptions
+

S

+
+
s3AccessKeyId(String) - Method in interface com.marklogic.flux.api.CustomExportWriteOptions
 
-
s3AccessKeyId(String) - Method in interface com.marklogic.flux.api.CustomImporter.CustomReadOptions
+
s3AccessKeyId(String) - Method in interface com.marklogic.flux.api.CustomImporter.CustomReadOptions
 
-
s3AccessKeyId(String) - Method in interface com.marklogic.flux.api.GenericFilesExporter.WriteGenericFilesOptions
+
s3AccessKeyId(String) - Method in interface com.marklogic.flux.api.GenericFilesExporter.WriteGenericFilesOptions
 
-
s3AccessKeyId(String) - Method in interface com.marklogic.flux.api.ReadFilesOptions
+
s3AccessKeyId(String) - Method in interface com.marklogic.flux.api.ReadFilesOptions
 
-
s3AccessKeyId(String) - Method in interface com.marklogic.flux.api.WriteFilesOptions
+
s3AccessKeyId(String) - Method in interface com.marklogic.flux.api.WriteFilesOptions
 
-
s3AddCredentials() - Method in interface com.marklogic.flux.api.CustomExportWriteOptions
+
s3AddCredentials() - Method in interface com.marklogic.flux.api.CustomExportWriteOptions
 
-
s3AddCredentials() - Method in interface com.marklogic.flux.api.CustomImporter.CustomReadOptions
+
s3AddCredentials() - Method in interface com.marklogic.flux.api.CustomImporter.CustomReadOptions
 
-
s3AddCredentials() - Method in interface com.marklogic.flux.api.GenericFilesExporter.WriteGenericFilesOptions
+
s3AddCredentials() - Method in interface com.marklogic.flux.api.GenericFilesExporter.WriteGenericFilesOptions
 
-
s3AddCredentials() - Method in interface com.marklogic.flux.api.ReadFilesOptions
+
s3AddCredentials() - Method in interface com.marklogic.flux.api.ReadFilesOptions
 
-
s3AddCredentials() - Method in interface com.marklogic.flux.api.WriteFilesOptions
+
s3AddCredentials() - Method in interface com.marklogic.flux.api.WriteFilesOptions
 
-
s3Endpoint(String) - Method in interface com.marklogic.flux.api.CustomExportWriteOptions
+
s3Endpoint(String) - Method in interface com.marklogic.flux.api.CustomExportWriteOptions
 
-
s3Endpoint(String) - Method in interface com.marklogic.flux.api.CustomImporter.CustomReadOptions
+
s3Endpoint(String) - Method in interface com.marklogic.flux.api.CustomImporter.CustomReadOptions
 
-
s3Endpoint(String) - Method in interface com.marklogic.flux.api.GenericFilesExporter.WriteGenericFilesOptions
+
s3Endpoint(String) - Method in interface com.marklogic.flux.api.GenericFilesExporter.WriteGenericFilesOptions
 
-
s3Endpoint(String) - Method in interface com.marklogic.flux.api.ReadFilesOptions
+
s3Endpoint(String) - Method in interface com.marklogic.flux.api.ReadFilesOptions
 
-
s3Endpoint(String) - Method in interface com.marklogic.flux.api.WriteFilesOptions
+
s3Endpoint(String) - Method in interface com.marklogic.flux.api.WriteFilesOptions
 
-
s3SecretAccessKey(String) - Method in interface com.marklogic.flux.api.CustomExportWriteOptions
+
s3SecretAccessKey(String) - Method in interface com.marklogic.flux.api.CustomExportWriteOptions
 
-
s3SecretAccessKey(String) - Method in interface com.marklogic.flux.api.CustomImporter.CustomReadOptions
+
s3SecretAccessKey(String) - Method in interface com.marklogic.flux.api.CustomImporter.CustomReadOptions
 
-
s3SecretAccessKey(String) - Method in interface com.marklogic.flux.api.GenericFilesExporter.WriteGenericFilesOptions
+
s3SecretAccessKey(String) - Method in interface com.marklogic.flux.api.GenericFilesExporter.WriteGenericFilesOptions
 
-
s3SecretAccessKey(String) - Method in interface com.marklogic.flux.api.ReadFilesOptions
+
s3SecretAccessKey(String) - Method in interface com.marklogic.flux.api.ReadFilesOptions
 
-
s3SecretAccessKey(String) - Method in interface com.marklogic.flux.api.WriteFilesOptions
+
s3SecretAccessKey(String) - Method in interface com.marklogic.flux.api.WriteFilesOptions
 
-
SAML - com.marklogic.flux.api.AuthenticationType
+
SAML - Enum constant in enum class com.marklogic.flux.api.AuthenticationType
 
-
samlToken(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
samlToken(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
saveMode(SaveMode) - Method in interface com.marklogic.flux.api.CustomExportWriteOptions
+
saveMode(SaveMode) - Method in interface com.marklogic.flux.api.CustomExportWriteOptions
 
-
saveMode(SaveMode) - Method in interface com.marklogic.flux.api.JdbcExporter.WriteRowsOptions
+
saveMode(SaveMode) - Method in interface com.marklogic.flux.api.JdbcExporter.WriteRowsOptions
 
-
SaveMode - Enum in com.marklogic.flux.api
+
SaveMode - Enum Class in com.marklogic.flux.api
Defines how data should be written to an external source if data already exists at the given location.
-
source(String) - Method in interface com.marklogic.flux.api.CustomImporter.CustomReadOptions
+
source(String) - Method in interface com.marklogic.flux.api.CustomImporter.CustomReadOptions
 
-
sslHostnameVerifier(SslHostnameVerifier) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
sslHostnameVerifier(SslHostnameVerifier) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
SslHostnameVerifier - Enum in com.marklogic.flux.api
+
SslHostnameVerifier - Enum Class in com.marklogic.flux.api
 
-
sslProtocol(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
sslProtocol(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
streaming() - Method in interface com.marklogic.flux.api.ArchiveFilesExporter
+
streaming() - Method in interface com.marklogic.flux.api.ArchiveFilesExporter
 
-
streaming() - Method in interface com.marklogic.flux.api.ArchiveFilesImporter
+
streaming() - Method in interface com.marklogic.flux.api.ArchiveFilesImporter
 
-
streaming() - Method in interface com.marklogic.flux.api.GenericFilesExporter
+
streaming() - Method in interface com.marklogic.flux.api.GenericFilesExporter
 
-
streaming() - Method in interface com.marklogic.flux.api.GenericFilesImporter
+
streaming() - Method in interface com.marklogic.flux.api.GenericFilesImporter
 
-
STRICT - com.marklogic.flux.api.SslHostnameVerifier
+
STRICT - Enum constant in enum class com.marklogic.flux.api.SslHostnameVerifier
 
-
stringQuery(String) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
+
stringQuery(String) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
 
-
stringQuery(String) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
+
stringQuery(String) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
 
- - - -

T

-
-
table(String) - Method in interface com.marklogic.flux.api.JdbcExporter.WriteRowsOptions
+

T

+
+
table(String) - Method in interface com.marklogic.flux.api.JdbcExporter.WriteRowsOptions
 
-
target(String) - Method in interface com.marklogic.flux.api.CustomExportWriteOptions
+
target(String) - Method in interface com.marklogic.flux.api.CustomExportWriteOptions
 
-
temporalCollection(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
+
temporalCollection(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
 
-
TEXT - com.marklogic.flux.api.GenericFilesImporter.DocumentType
+
TEXT - Enum constant in enum class com.marklogic.flux.api.GenericFilesImporter.DocumentType
 
-
threadCount(int) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
+
threadCount(int) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
 
-
threadCountPerPartition(int) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
+
threadCountPerPartition(int) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
 
-
to(String) - Method in interface com.marklogic.flux.api.ArchiveFilesExporter
+
to(String) - Method in interface com.marklogic.flux.api.ArchiveFilesExporter
 
-
to(String) - Method in interface com.marklogic.flux.api.AvroFilesExporter
+
to(String) - Method in interface com.marklogic.flux.api.AvroFilesExporter
 
-
to(String) - Method in interface com.marklogic.flux.api.DelimitedFilesExporter
+
to(String) - Method in interface com.marklogic.flux.api.DelimitedFilesExporter
 
-
to(String) - Method in interface com.marklogic.flux.api.GenericFilesExporter
+
to(String) - Method in interface com.marklogic.flux.api.GenericFilesExporter
 
-
to(String) - Method in interface com.marklogic.flux.api.JsonLinesFilesExporter
+
to(String) - Method in interface com.marklogic.flux.api.JsonLinesFilesExporter
 
-
to(String) - Method in interface com.marklogic.flux.api.OrcFilesExporter
+
to(String) - Method in interface com.marklogic.flux.api.OrcFilesExporter
 
-
to(String) - Method in interface com.marklogic.flux.api.ParquetFilesExporter
+
to(String) - Method in interface com.marklogic.flux.api.ParquetFilesExporter
 
-
to(String) - Method in interface com.marklogic.flux.api.RdfFilesExporter
+
to(String) - Method in interface com.marklogic.flux.api.RdfFilesExporter
 
-
to(Consumer<ArchiveFilesExporter.WriteArchiveFilesOptions>) - Method in interface com.marklogic.flux.api.ArchiveFilesExporter
+
to(Consumer<ArchiveFilesExporter.WriteArchiveFilesOptions>) - Method in interface com.marklogic.flux.api.ArchiveFilesExporter
 
-
to(Consumer<CustomExportWriteOptions>) - Method in interface com.marklogic.flux.api.CustomDocumentsExporter
+
to(Consumer<CustomExportWriteOptions>) - Method in interface com.marklogic.flux.api.CustomDocumentsExporter
 
-
to(Consumer<CustomExportWriteOptions>) - Method in interface com.marklogic.flux.api.CustomRowsExporter
+
to(Consumer<CustomExportWriteOptions>) - Method in interface com.marklogic.flux.api.CustomRowsExporter
 
-
to(Consumer<DelimitedFilesExporter.WriteDelimitedFilesOptions>) - Method in interface com.marklogic.flux.api.DelimitedFilesExporter
+
to(Consumer<DelimitedFilesExporter.WriteDelimitedFilesOptions>) - Method in interface com.marklogic.flux.api.DelimitedFilesExporter
 
-
to(Consumer<GenericFilesExporter.WriteGenericFilesOptions>) - Method in interface com.marklogic.flux.api.GenericFilesExporter
+
to(Consumer<GenericFilesExporter.WriteGenericFilesOptions>) - Method in interface com.marklogic.flux.api.GenericFilesExporter
 
-
to(Consumer<GenericFilesImporter.WriteGenericDocumentsOptions>) - Method in interface com.marklogic.flux.api.GenericFilesImporter
+
to(Consumer<GenericFilesImporter.WriteGenericDocumentsOptions>) - Method in interface com.marklogic.flux.api.GenericFilesImporter
 
-
to(Consumer<JdbcExporter.WriteRowsOptions>) - Method in interface com.marklogic.flux.api.JdbcExporter
+
to(Consumer<JdbcExporter.WriteRowsOptions>) - Method in interface com.marklogic.flux.api.JdbcExporter
 
-
to(Consumer<JsonLinesFilesExporter.WriteJsonLinesFilesOptions>) - Method in interface com.marklogic.flux.api.JsonLinesFilesExporter
+
to(Consumer<JsonLinesFilesExporter.WriteJsonLinesFilesOptions>) - Method in interface com.marklogic.flux.api.JsonLinesFilesExporter
 
-
to(Consumer<RdfFilesExporter.WriteRdfFilesOptions>) - Method in interface com.marklogic.flux.api.RdfFilesExporter
+
to(Consumer<RdfFilesExporter.WriteRdfFilesOptions>) - Method in interface com.marklogic.flux.api.RdfFilesExporter
 
-
to(Consumer<RdfFilesImporter.WriteTriplesDocumentsOptions>) - Method in interface com.marklogic.flux.api.RdfFilesImporter
+
to(Consumer<RdfFilesImporter.WriteTriplesDocumentsOptions>) - Method in interface com.marklogic.flux.api.RdfFilesImporter
 
-
to(Consumer<Reprocessor.WriteOptions>) - Method in interface com.marklogic.flux.api.Reprocessor
+
to(Consumer<Reprocessor.WriteOptions>) - Method in interface com.marklogic.flux.api.Reprocessor
 
-
to(Consumer<WriteDocumentsOptions<? extends WriteDocumentsOptions>>) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter
+
to(Consumer<WriteDocumentsOptions<? extends WriteDocumentsOptions>>) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter
 
-
to(Consumer<WriteDocumentsOptions<? extends WriteDocumentsOptions>>) - Method in interface com.marklogic.flux.api.ArchiveFilesImporter
+
to(Consumer<WriteDocumentsOptions<? extends WriteDocumentsOptions>>) - Method in interface com.marklogic.flux.api.ArchiveFilesImporter
 
-
to(Consumer<WriteDocumentsOptions<? extends WriteDocumentsOptions>>) - Method in interface com.marklogic.flux.api.DocumentCopier
+
to(Consumer<WriteDocumentsOptions<? extends WriteDocumentsOptions>>) - Method in interface com.marklogic.flux.api.DocumentCopier
 
-
to(Consumer<WriteDocumentsOptions<? extends WriteDocumentsOptions>>) - Method in interface com.marklogic.flux.api.MlcpArchiveFilesImporter
+
to(Consumer<WriteDocumentsOptions<? extends WriteDocumentsOptions>>) - Method in interface com.marklogic.flux.api.MlcpArchiveFilesImporter
 
-
to(Consumer<WriteSparkFilesOptions>) - Method in interface com.marklogic.flux.api.AvroFilesExporter
+
to(Consumer<WriteSparkFilesOptions>) - Method in interface com.marklogic.flux.api.AvroFilesExporter
 
-
to(Consumer<WriteSparkFilesOptions>) - Method in interface com.marklogic.flux.api.OrcFilesExporter
+
to(Consumer<WriteSparkFilesOptions>) - Method in interface com.marklogic.flux.api.OrcFilesExporter
 
-
to(Consumer<WriteSparkFilesOptions>) - Method in interface com.marklogic.flux.api.ParquetFilesExporter
+
to(Consumer<WriteSparkFilesOptions>) - Method in interface com.marklogic.flux.api.ParquetFilesExporter
 
-
to(Consumer<WriteStructuredDocumentsOptions>) - Method in interface com.marklogic.flux.api.AggregateJsonFilesImporter
+
to(Consumer<WriteStructuredDocumentsOptions>) - Method in interface com.marklogic.flux.api.AggregateJsonFilesImporter
 
-
to(Consumer<WriteStructuredDocumentsOptions>) - Method in interface com.marklogic.flux.api.AvroFilesImporter
+
to(Consumer<WriteStructuredDocumentsOptions>) - Method in interface com.marklogic.flux.api.AvroFilesImporter
 
-
to(Consumer<WriteStructuredDocumentsOptions>) - Method in interface com.marklogic.flux.api.CustomImporter
+
to(Consumer<WriteStructuredDocumentsOptions>) - Method in interface com.marklogic.flux.api.CustomImporter
 
-
to(Consumer<WriteStructuredDocumentsOptions>) - Method in interface com.marklogic.flux.api.DelimitedFilesImporter
+
to(Consumer<WriteStructuredDocumentsOptions>) - Method in interface com.marklogic.flux.api.DelimitedFilesImporter
 
-
to(Consumer<WriteStructuredDocumentsOptions>) - Method in interface com.marklogic.flux.api.JdbcImporter
+
to(Consumer<WriteStructuredDocumentsOptions>) - Method in interface com.marklogic.flux.api.JdbcImporter
 
-
to(Consumer<WriteStructuredDocumentsOptions>) - Method in interface com.marklogic.flux.api.OrcFilesImporter
+
to(Consumer<WriteStructuredDocumentsOptions>) - Method in interface com.marklogic.flux.api.OrcFilesImporter
 
-
to(Consumer<WriteStructuredDocumentsOptions>) - Method in interface com.marklogic.flux.api.ParquetFilesImporter
+
to(Consumer<WriteStructuredDocumentsOptions>) - Method in interface com.marklogic.flux.api.ParquetFilesImporter
 
-
transform(String) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
+
transform(String) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
 
-
transform(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
+
transform(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
 
-
transformParams(String) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
+
transformParams(String) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
 
-
transformParams(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
+
transformParams(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
 
-
transformParamsDelimiter(String) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
+
transformParamsDelimiter(String) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
 
-
transformParamsDelimiter(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
+
transformParamsDelimiter(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
 
-
trustStoreAlgorithm(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
trustStoreAlgorithm(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
trustStorePassword(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
trustStorePassword(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
trustStorePath(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
trustStorePath(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
-
trustStoreType(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
trustStoreType(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
- - - -

U

-
-
uriElement(String) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter.ReadXmlFilesOptions
+

U

+
+
uriElement(String) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter.ReadXmlFilesOptions
 
-
uriIncludeFilePath(boolean) - Method in interface com.marklogic.flux.api.AggregateJsonFilesImporter.ReadJsonFilesOptions
+
uriIncludeFilePath(boolean) - Method in interface com.marklogic.flux.api.AggregateJsonFilesImporter.ReadJsonFilesOptions
 
-
uriIncludeFilePath(boolean) - Method in interface com.marklogic.flux.api.DelimitedFilesImporter.ReadDelimitedFilesOptions
+
uriIncludeFilePath(boolean) - Method in interface com.marklogic.flux.api.DelimitedFilesImporter.ReadDelimitedFilesOptions
 
-
uriIncludeFilePath(boolean) - Method in interface com.marklogic.flux.api.ReadTabularFilesOptions
+
uriIncludeFilePath(boolean) - Method in interface com.marklogic.flux.api.ReadTabularFilesOptions
 
-
uriNamespace(String) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter.ReadXmlFilesOptions
+
uriNamespace(String) - Method in interface com.marklogic.flux.api.AggregateXmlFilesImporter.ReadXmlFilesOptions
 
-
uriPrefix(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
+
uriPrefix(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
 
-
uriReplace(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
+
uriReplace(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
 
-
uris(String...) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
+
uris(String...) - Method in interface com.marklogic.flux.api.RdfFilesExporter.ReadTriplesDocumentsOptions
 
-
uris(String...) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
+
uris(String...) - Method in interface com.marklogic.flux.api.ReadDocumentsOptions
 
-
uriSuffix(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
+
uriSuffix(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
 
-
uriTemplate(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
+
uriTemplate(String) - Method in interface com.marklogic.flux.api.WriteDocumentsOptions
 
-
url(String) - Method in interface com.marklogic.flux.api.JdbcOptions
+
url(String) - Method in interface com.marklogic.flux.api.JdbcOptions
 
-
user(String) - Method in interface com.marklogic.flux.api.JdbcOptions
+
user(String) - Method in interface com.marklogic.flux.api.JdbcOptions
 
-
username(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
+
username(String) - Method in interface com.marklogic.flux.api.ConnectionOptions
 
- - - -

V

-
-
valueOf(String) - Static method in enum com.marklogic.flux.api.AuthenticationType
+

V

+
+
valueOf(String) - Static method in enum class com.marklogic.flux.api.AuthenticationType
-
Returns the enum constant of this type with the specified name.
+
Returns the enum constant of this class with the specified name.
-
valueOf(String) - Static method in enum com.marklogic.flux.api.CompressionType
+
valueOf(String) - Static method in enum class com.marklogic.flux.api.CompressionType
-
Returns the enum constant of this type with the specified name.
+
Returns the enum constant of this class with the specified name.
-
valueOf(String) - Static method in enum com.marklogic.flux.api.GenericFilesImporter.DocumentType
+
valueOf(String) - Static method in enum class com.marklogic.flux.api.GenericFilesImporter.DocumentType
-
Returns the enum constant of this type with the specified name.
+
Returns the enum constant of this class with the specified name.
-
valueOf(String) - Static method in enum com.marklogic.flux.api.SaveMode
+
valueOf(String) - Static method in enum class com.marklogic.flux.api.SaveMode
-
Returns the enum constant of this type with the specified name.
+
Returns the enum constant of this class with the specified name.
-
valueOf(String) - Static method in enum com.marklogic.flux.api.SslHostnameVerifier
+
valueOf(String) - Static method in enum class com.marklogic.flux.api.SslHostnameVerifier
-
Returns the enum constant of this type with the specified name.
+
Returns the enum constant of this class with the specified name.
-
values() - Static method in enum com.marklogic.flux.api.AuthenticationType
+
values() - Static method in enum class com.marklogic.flux.api.AuthenticationType
-
Returns an array containing the constants of this enum type, in +
Returns an array containing the constants of this enum class, in the order they are declared.
-
values() - Static method in enum com.marklogic.flux.api.CompressionType
+
values() - Static method in enum class com.marklogic.flux.api.CompressionType
-
Returns an array containing the constants of this enum type, in +
Returns an array containing the constants of this enum class, in the order they are declared.
-
values() - Static method in enum com.marklogic.flux.api.GenericFilesImporter.DocumentType
+
values() - Static method in enum class com.marklogic.flux.api.GenericFilesImporter.DocumentType
-
Returns an array containing the constants of this enum type, in +
Returns an array containing the constants of this enum class, in the order they are declared.
-
values() - Static method in enum com.marklogic.flux.api.SaveMode
+
values() - Static method in enum class com.marklogic.flux.api.SaveMode
-
Returns an array containing the constants of this enum type, in +
Returns an array containing the constants of this enum class, in the order they are declared.
-
values() - Static method in enum com.marklogic.flux.api.SslHostnameVerifier
+
values() - Static method in enum class com.marklogic.flux.api.SslHostnameVerifier
-
Returns an array containing the constants of this enum type, in +
Returns an array containing the constants of this enum class, in the order they are declared.
-
vars(Map<String, String>) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
+
vars(Map<String, String>) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
 
-
vars(Map<String, String>) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
+
vars(Map<String, String>) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
 
- - - -

W

-
-
withSparkSession(Object) - Method in interface com.marklogic.flux.api.Executor
+

W

+
+
withSparkSession(Object) - Method in interface com.marklogic.flux.api.Executor
Execute this executor with a user-defined Spark session.
-
WriteDocumentsOptions<T extends WriteDocumentsOptions> - Interface in com.marklogic.flux.api
+
WriteDocumentsOptions<T extends WriteDocumentsOptions> - Interface in com.marklogic.flux.api
 
-
WriteFilesOptions<T extends WriteFilesOptions> - Interface in com.marklogic.flux.api
+
WriteFilesOptions<T extends WriteFilesOptions> - Interface in com.marklogic.flux.api
 
-
WriteSparkFilesOptions - Interface in com.marklogic.flux.api
+
WriteSparkFilesOptions - Interface in com.marklogic.flux.api
For objects that can export files via a Spark data source, where the Spark data source supports additional options that do not have dedicated methods in the exporter interface.
-
WriteStructuredDocumentsOptions - Interface in com.marklogic.flux.api
+
WriteStructuredDocumentsOptions - Interface in com.marklogic.flux.api
Defines options for writing "structured" documents - i.e.
- - - -

X

-
-
XML - com.marklogic.flux.api.GenericFilesImporter.DocumentType
+

X

+
+
XML - Enum constant in enum class com.marklogic.flux.api.GenericFilesImporter.DocumentType
 
-
xmlNamespace(String) - Method in interface com.marklogic.flux.api.WriteStructuredDocumentsOptions
+
xmlNamespace(String) - Method in interface com.marklogic.flux.api.WriteStructuredDocumentsOptions
 
-
xmlRootName(String) - Method in interface com.marklogic.flux.api.WriteStructuredDocumentsOptions
+
xmlRootName(String) - Method in interface com.marklogic.flux.api.WriteStructuredDocumentsOptions
 
-
xquery(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
+
xquery(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
 
-
xquery(String) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
+
xquery(String) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
 
-
xqueryFile(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
+
xqueryFile(String) - Method in interface com.marklogic.flux.api.Reprocessor.ReadOptions
 
-
xqueryFile(String) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
+
xqueryFile(String) - Method in interface com.marklogic.flux.api.Reprocessor.WriteOptions
 
- - - -

Z

-
-
ZIP - com.marklogic.flux.api.CompressionType
+

Z

+
+
ZIP - Enum constant in enum class com.marklogic.flux.api.CompressionType
 
-
zipFileCount(int) - Method in interface com.marklogic.flux.api.GenericFilesExporter.WriteGenericFilesOptions
+
zipFileCount(int) - Method in interface com.marklogic.flux.api.GenericFilesExporter.WriteGenericFilesOptions
 
-A B C D E F G H I J K L M N O P Q R S T U V W X Z 
All Classes All Packages
- - diff --git a/docs/assets/javadoc/index.html b/docs/assets/javadoc/index.html index f0ab2d1e..c2466969 100644 --- a/docs/assets/javadoc/index.html +++ b/docs/assets/javadoc/index.html @@ -1,18 +1,20 @@ - - + flux-cli 1.1.3 API + + + + + - - - +