kudu-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From danburk...@apache.org
Subject [1/2] incubator-kudu git commit: Fix some Asciidoc syntax problems in the documentation.
Date Mon, 11 Apr 2016 18:50:23 GMT
Repository: incubator-kudu
Updated Branches:
  refs/heads/master 0bab4ac1c -> 00ac42f54


Fix some Asciidoc syntax problems in the documentation.

Also corrected the link to the HybribTime tech report in
the Transaction Semantics page.

Change-Id: I392cb97d677d7de88f1462049eac234b2212d48b
Reviewed-on: http://gerrit.cloudera.org:8080/2746
Tested-by: Kudu Jenkins
Reviewed-by: Mike Percy <mpercy@apache.org>
Reviewed-by: Misty Stanley-Jones <misty@apache.org>


Project: http://git-wip-us.apache.org/repos/asf/incubator-kudu/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-kudu/commit/08092e49
Tree: http://git-wip-us.apache.org/repos/asf/incubator-kudu/tree/08092e49
Diff: http://git-wip-us.apache.org/repos/asf/incubator-kudu/diff/08092e49

Branch: refs/heads/master
Commit: 08092e494319f9437a25f21ab89ab696e9d520d8
Parents: 0bab4ac
Author: Andre Araujo <araujo@cloudera.com>
Authored: Sun Apr 10 20:25:42 2016 -0700
Committer: Misty Stanley-Jones <misty@apache.org>
Committed: Mon Apr 11 16:28:29 2016 +0000

----------------------------------------------------------------------
 docs/administration.adoc          |  1 +
 docs/kudu_impala_integration.adoc | 26 +++++++++++++-------------
 docs/schema_design.adoc           | 17 +++++++++--------
 docs/transaction_semantics.adoc   |  4 ++--
 docs/troubleshooting.adoc         |  1 +
 5 files changed, 26 insertions(+), 23 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-kudu/blob/08092e49/docs/administration.adoc
----------------------------------------------------------------------
diff --git a/docs/administration.adoc b/docs/administration.adoc
index f45d7f8..e6046c0 100644
--- a/docs/administration.adoc
+++ b/docs/administration.adoc
@@ -136,6 +136,7 @@ $ curl -s 'http://example-ts:8050/metrics?include_schema=1&metrics=connections_a
         ]
     }
 ]
+----
 
 [source,bash]
 ----

http://git-wip-us.apache.org/repos/asf/incubator-kudu/blob/08092e49/docs/kudu_impala_integration.adoc
----------------------------------------------------------------------
diff --git a/docs/kudu_impala_integration.adoc b/docs/kudu_impala_integration.adoc
index 9dff8b7..b85cd74 100755
--- a/docs/kudu_impala_integration.adoc
+++ b/docs/kudu_impala_integration.adoc
@@ -467,12 +467,12 @@ TBLPROPERTIES(
   'kudu.table_name' = 'cust_behavior',
   'kudu.master_addresses' = 'a1216.halxg.cloudera.com:7051',
   'kudu.key_columns' = '_id',
-  'kudu.num_tablet_replicas' = '3',
+  'kudu.num_tablet_replicas' = '3'
 );
 ----
 
 If you have multiple primary key columns, you can specify split points by separating
-them with commas within the inner brackets: `[['va',1],['ab',2]]`. The expression
+them with commas within the inner brackets: `\(('va',1), ('ab',2))`. The expression
 must be valid JSON.
 
 ==== Impala Databases and Kudu
@@ -488,7 +488,7 @@ scopes, called `databases`. To create a database, use a `CREATE DATABASE`
 statement. To use the database for further Impala operations such as `CREATE TABLE`,
 use the `USE` statement. For example, to create a table in a database called `impala_kudu`,
 use the following SQL:
-+
+
 [source,sql]
 ----
 CREATE DATABASE impala_kudu
@@ -504,12 +504,12 @@ TBLPROPERTIES(
   'kudu.key_columns' = 'id'
 );
 ----
-+
+
 The `my_first_table` table is created within the `impala_kudu` database. To refer
 to this database in the future, without using a specific `USE` statement, you can
 refer to the table using `<database>.<table>` syntax. For example, to specify
the
 `my_first_table` table in database `impala_kudu`, as opposed to any other table with
-the same name in another database, use `impala_kudu:my_first_table`. This also applies
+the same name in another database, use `impala_kudu.my_first_table`. This also applies
 to `INSERT`, `UPDATE`, `DELETE`, and `DROP` statements.
 
 WARNING: Currently, Kudu does not encode the Impala database into the table name
@@ -530,7 +530,7 @@ The following Impala keywords are not supported when creating Kudu tables:
 === Optimizing Performance for Evaluating SQL Predicates
 
 If the `WHERE` clause of your query includes comparisons with the operators
-`=`, `<=`, or `>=`, Kudu evaluates the condition directly and only returns the
+`=`, `\<=`, or `>=`, Kudu evaluates the condition directly and only returns the
 relevant results. This provides optimum performance, because Kudu only returns the
 relevant results to Impala. For predicates `<`, `>`, `!=`, or any other predicate
 type supported by Impala, Kudu does not evaluate the predicates directly, but returns
@@ -852,9 +852,9 @@ Batch Insert:: The approach that usually performs best, from the standpoint
of
 both Impala and Kudu, is usually to import the data using a `SELECT FROM` statement
 in Impala.
 +
-. If your data is not already in Impala, one strategy is
-to link:http://www.cloudera.com/content/cloudera/en/documentation/core/latest/topics/impala_txtfile.html
-[import it from a text file], such as a TSV or CSV file.
+. If your data is not already in Impala, one strategy is to
+link:http://www.cloudera.com/content/cloudera/en/documentation/core/latest/topics/impala_txtfile.html[import
it from a text file],
+such as a TSV or CSV file.
 +
 . <<kudu_impala_create_table,Create the Kudu table>>, being mindful that the
columns
 designated as primary keys cannot have null values.
@@ -910,7 +910,7 @@ You can update in bulk using the same approaches outlined in
 
 ==== `UPDATE` and the `IGNORE` Keyword
 
-Similar to <<insert_ignore>>You can use the `IGNORE` operation to ignore an `UPDATE`
+Similarly to <<insert_ignore>>, you can use the `IGNORE` operation to ignore
an `UPDATE`
 which would otherwise fail. For instance, a row may be deleted while you are
 attempting to update it. In Impala, this would cause an error. The `IGNORE`
 keyword causes the error to be ignored.
@@ -945,7 +945,7 @@ You can delete in bulk using the same approaches outlined in
 
 ==== `DELETE` and the `IGNORE` Keyword
 
-Similar to <<insert_ignore>>You can use the `IGNORE` operation to ignore an `DELETE`
+Similarly to <<insert_ignore>>, you can use the `IGNORE` operation to ignore
an `DELETE`
 which would otherwise fail. For instance, a row may be deleted by another process
 while you are attempting to delete it. In Impala, this would cause an error. The
 `IGNORE` keyword causes the error to be ignored.
@@ -996,12 +996,12 @@ ALTER TABLE my_table SET TBLPROPERTIES('EXTERNAL' = 'TRUE');
 
 === Dropping a Kudu Table Using Impala
 
-- If the table was created as an internal table in Impala, using `CREATE TABLE`, the
+If the table was created as an internal table in Impala, using `CREATE TABLE`, the
 standard `DROP TABLE` syntax drops the underlying Kudu table and all its data. If
 the table was created as an external table, using `CREATE EXTERNAL TABLE`, the mapping
 between Impala and Kudu is dropped, but the Kudu table is left intact, with all its
 data.
-+
+
 [source,sql]
 ----
 DROP TABLE my_first_table;

http://git-wip-us.apache.org/repos/asf/incubator-kudu/blob/08092e49/docs/schema_design.adoc
----------------------------------------------------------------------
diff --git a/docs/schema_design.adoc b/docs/schema_design.adoc
index e416ed7..7cd1230 100644
--- a/docs/schema_design.adoc
+++ b/docs/schema_design.adoc
@@ -49,13 +49,13 @@ Columns that are not part of the primary key may optionally be nullable.
 Supported column types include:
 
 * boolean
-* 8 bit signed integer
-* 16 bit signed integer
-* 32 bit signed integer
-* 64 bit signed integer
+* 8-bit signed integer
+* 16-bit signed integer
+* 32-bit signed integer
+* 64-bit signed integer
 * timestamp
-* single-precision (32 bit) IEEE-754 floating-point number
-* double-precision (64 bit) IEEE-754 floating-point number
+* single-precision (32-bit) IEEE-754 floating-point number
+* double-precision (64-bit) IEEE-754 floating-point number
 * UTF-8 encoded string
 * binary
 
@@ -73,6 +73,7 @@ Each column in a Kudu table can be created with an encoding, based on the
type
 of the column. Columns use plain encoding by default.
 
 .Encoding Types
+[options="header"]
 |===
 | Column Type        | Encoding
 | integer, timestamp | plain, bitshuffle, run length
@@ -95,7 +96,7 @@ https://github.com/kiyo-masui/bitshuffle[bitshuffle] project has a good
 overview of performance and use cases.
 
 [[run-length]]
-Run Length Encoding:: _Runs_ (consecutive repeated values), are compressed in a
+Run Length Encoding:: _Runs_ (consecutive repeated values) are compressed in a
 column by storing only the value and the count. Run length encoding is effective
 for columns with many consecutive repeated values when sorted by primary key.
 
@@ -118,7 +119,7 @@ column of the primary key, since rows are sorted by primary key within
tablets.
 Kudu allows per-column compression using LZ4, `snappy`, or `zlib` compression
 codecs. By default, columns are stored uncompressed. Consider using compression
 if reducing storage space is more important than raw scan performance.
-+
+
 Every data set will compress differently, but in general LZ4 has the least effect on
 performance, while `zlib` will compress to the smallest data sizes.
 Bitshuffle-encoded columns are inherently compressed using LZ4, so it is not

http://git-wip-us.apache.org/repos/asf/incubator-kudu/blob/08092e49/docs/transaction_semantics.adoc
----------------------------------------------------------------------
diff --git a/docs/transaction_semantics.adoc b/docs/transaction_semantics.adoc
index 9e80211..1db342b 100644
--- a/docs/transaction_semantics.adoc
+++ b/docs/transaction_semantics.adoc
@@ -177,7 +177,7 @@ Selecting between read modes requires balancing the trade-offs and making
a choi
 that fits your workload. For instance, a reporting application that needs to
 scan the entire database might need to perform careful accounting operations, so that
 scan may need to be fault-tolerant, but probably doesn't require a to-the-microsecond
-up-to-date view of the database. In that case, you might choose 'READ_AT_SNAPSHOT'
+up-to-date view of the database. In that case, you might choose `READ_AT_SNAPSHOT`
 and select a timestamp that is a few seconds in the past when the scan starts. On
 the other hand, a machine learning workload that is not ingesting the whole data
 set and is already statistical in nature might not require the scan to be repeatable,
@@ -250,7 +250,7 @@ frequently.
 
 [bibliography]
 .References
-- [[[1]]] David Alves, Todd Lipcon and Vijay Garg. Technical Report: HybridTime - Accessible
Global Consistency with High Clock Uncertainty. April, 2014. http://pdsl.ece.utexas.edu/david/hybrid-time-tech-report-01.pdf
+- [[[1]]] David Alves, Todd Lipcon and Vijay Garg. Technical Report: HybridTime - Accessible
Global Consistency with High Clock Uncertainty. April, 2014. http://users.ece.utexas.edu/~garg/pdslab/david/hybrid-time-tech-report-01.pdf
 - [[[2]]] James C. Corbett, Jeffrey Dean, Michael Epstein, Andrew Fikes, Christopher Frost,
J. J. Furman, Sanjay Ghemawat, Andrey Gubarev, Christopher Heiser, Peter Hochschild, Wilson
Hsieh, Sebastian Kanthak, Eugene Kogan, Hongyi Li, Alexander Lloyd, Sergey Melnik, David Mwaura,
David Nagle, Sean Quinlan, Rajesh Rao, Lindsay Rolig, Yasushi Saito, Michal Szymaniak, Christopher
Taylor, Ruth Wang, and Dale Woodford. 2012. Spanner: Google's globally-distributed database.
In Proceedings of the 10th USENIX conference on Operating Systems Design and Implementation
(OSDI'12). USENIX Association, Berkeley, CA, USA, 251-264.
 - [[[3]]] Alexander Thomson, Thaddeus Diamond, Shu-Chun Weng, Kun Ren, Philip Shao, and Daniel
J. Abadi. 2012. Calvin: fast distributed transactions for partitioned database systems. In
Proceedings of the 2012 ACM SIGMOD International Conference on Management of Data (SIGMOD
'12). ACM, New York, NY, USA, 1-12. DOI=10.1145/2213836.2213838 http://doi.acm.org/10.1145/2213836.2213838
 - [[[4]]] Diego Ongaro and John Ousterhout. 2014. In search of an understandable consensus
algorithm. In Proceedings of the 2014 USENIX conference on USENIX Annual Technical Conference
(USENIX ATC'14), Garth Gibson and Nickolai Zeldovich (Eds.). USENIX Association, Berkeley,
CA, USA, 305-320.

http://git-wip-us.apache.org/repos/asf/incubator-kudu/blob/08092e49/docs/troubleshooting.adoc
----------------------------------------------------------------------
diff --git a/docs/troubleshooting.adoc b/docs/troubleshooting.adoc
index 23d0267..b95ac95 100644
--- a/docs/troubleshooting.adoc
+++ b/docs/troubleshooting.adoc
@@ -131,6 +131,7 @@ The tracing interface is accessed via a web browser as part of the
 embedded web server in each of the Kudu daemons.
 
 .Tracing Interface URLs
+[options="header"]
 |===
 | Daemon | URL
 | Tablet Server | http://tablet-server-1.example.com:8050/tracing.html


Mime
View raw message