This is an automated email from the ASF dual-hosted git repository.
hutran pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-gobblin.git
The following commit(s) were added to refs/heads/master by this push:
new fbb96c6 [GOBBLIN-891] Fixing Couchbase writer docs
fbb96c6 is described below
commit fbb96c6b3759adef4bcd556168f9d1c99b08a40a
Author: Shirshanka Das <[email protected]>
AuthorDate: Tue Oct 1 18:40:24 2019 -0700
[GOBBLIN-891] Fixing Couchbase writer docs
Closes #2746 from shirshanka/fix-couchbase-doc
---
gobblin-docs/sinks/Couchbase-Writer.md | 14 --------------
gobblin-docs/{writers => sinks}/CouchbaseWriter.md | 6 +++---
mkdocs.yml | 6 ++----
3 files changed, 5 insertions(+), 21 deletions(-)
diff --git a/gobblin-docs/sinks/Couchbase-Writer.md
b/gobblin-docs/sinks/Couchbase-Writer.md
deleted file mode 100644
index 6527008..0000000
--- a/gobblin-docs/sinks/Couchbase-Writer.md
+++ /dev/null
@@ -1,14 +0,0 @@
-TODO [GOBBLIN-59](https://issues.apache.org/jira/browse/GOBBLIN-59)
-
-# Description
-
-
-Writes records to Couchbase.
-
-# Usage
-
-
-This writer is part of the gobblin-couchbase [Gobblin
Module](https://github.com/apache/incubator-gobblin/tree/master/gobblin-modules/gobblin-couchbase).
See
-
[`CouchbaseWriter`](https://github.com/apache/incubator-gobblin/blob/master/gobblin-modules/gobblin-couchbase/src/main/java/org/apache/gobblin/couchbase/writer/CouchbaseWriter.java)
for more info.
-
- # Configuration
\ No newline at end of file
diff --git a/gobblin-docs/writers/CouchbaseWriter.md
b/gobblin-docs/sinks/CouchbaseWriter.md
similarity index 91%
rename from gobblin-docs/writers/CouchbaseWriter.md
rename to gobblin-docs/sinks/CouchbaseWriter.md
index 2b520e5..ccf0225 100644
--- a/gobblin-docs/writers/CouchbaseWriter.md
+++ b/gobblin-docs/sinks/CouchbaseWriter.md
@@ -1,7 +1,7 @@
[TOC]
# Introduction
-A CouchbaseWriter is both an AsyncDataWriter a SyncDataWriter that pushes
Documents to a couchbase bucket though the [JAVA
SDK](https://docs.couchbase.com/java-sdk/current/start-using-sdk.html). Note
that CouchbaseWiter only supports writing to a single bucket as there should be
only 1 CouchbaseEnvironment per JVM.
+The
[CouchbaseWriter](https://github.com/apache/incubator-gobblin/blob/master/gobblin-modules/gobblin-couchbase/src/main/java/org/apache/gobblin/couchbase/writer/CouchbaseWriter.java)
supports writing documents to a Couchbase bucket though the [Couchbase Java
SDK](https://docs.couchbase.com/java-sdk/current/start-using-sdk.html). Note
that CouchbaseWriter only supports writing to a single bucket as there should
be only 1 CouchbaseEnvironment per JVM.
# Record format
@@ -89,7 +89,7 @@ Note that the key can be other than string if needed.
| `writer.couchbase.documentTTLOriginUnits` | `MILLISECONDS` | Unit for
`writer.couchbase.documentTTL`. Must be one of
[java.util.concurrent.TimeUnit](https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html).
Case insensitive. As an example a `writer.couchbase.documentTTLOriginField`
value of `1568240399000` and `writer.couchbase.documentTTLOriginUnits` value of
`MILLISECONDS` timeunit would be `Wed Sep 11 15:19:59 PDT 2019` |
| `writer.couchbase.retriesEnabled` | `false` | Enable write retries on
failures |
| `writer.couchbase.maxRetries` | `5` | Maximum number of retries |
-| `writer.couchbase.failureAllowancePercentage` | `0.0` | The percentage of
failures that you are willing to tolerate while writing to Couchbase. Gobblin
will mark the workunit successful and move on if there are failures but not
enough to trip the failure threshold. Only successfully acknowledged writes are
counted as successful, all others are considered as failures. The default for
the failureAllowancePercentage is set to 0.0. For example, if the value is set
to 0.2 This means that as [...]
+| `writer.couchbase.failureAllowancePercentage` | `0.0` | The percentage of
failures that you are willing to tolerate while writing to Couchbase. Gobblin
will mark the workunit successful and move on if there are failures but not
enough to trip the failure threshold. Only successfully acknowledged writes are
counted as successful, all others are considered as failures. The default for
the failureAllowancePercentage is set to 0.0. For example, if the value is set
to 0.2 This means that as [...]
|`operationTimeoutMillis` | `10000` | Global timeout for couchbase
communication operations |
## Authentication
@@ -144,4 +144,4 @@ So a sample document with origin on 1568240399 (Wed Sep 11
15:19:59 PDT 2019) wo
}
```
-}
\ No newline at end of file
+}
diff --git a/mkdocs.yml b/mkdocs.yml
index 69996b6..4a0442c 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -62,14 +62,12 @@ pages:
- SQL Server: sources/SqlServerSource.md
- Teradata: sources/TeradataSource.md
- Wikipedia: sources/WikipediaSource.md
- - Writers:
- - CouchbaseWriter: CouchbaseWriter.md
- - Record Sinks:
+ - Sinks (Writers):
- Avro HDFS: sinks/AvroHdfsDataWriter.md
- Parquet HDFS: sinks/ParquetHdfsDataWriter.md
- HDFS Byte array: sinks/SimpleBytesWriter.md
- Console: sinks/ConsoleWriter.md
- - Couchbase: sinks/Couchbase-Writer.md
+ - Couchbase: sinks/CouchbaseWriter.md
- HTTP: sinks/Http.md
- JDBC: sinks/Gobblin-JDBC-Writer.md
- Kafka: sinks/Kafka.md
