Skip to content

Commit 826909a

Browse files
committed
HBASE-20344 Fix asciidoc warnings
Signed-off-by: Sean Busbey <busbey@apache.org>
1 parent d59a6c8 commit 826909a

File tree

9 files changed

+53
-105
lines changed

9 files changed

+53
-105
lines changed

src/main/asciidoc/_chapters/backup_restore.adoc

Lines changed: 53 additions & 53 deletions
Large diffs are not rendered by default.

src/main/asciidoc/_chapters/compression.adoc

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -335,25 +335,18 @@ You do not need to re-create the table or copy data.
335335
If you are changing codecs, be sure the old codec is still available until all the old StoreFiles have been compacted.
336336
337337
.Enabling Compression on a ColumnFamily of an Existing Table using HBaseShell
338-
====
339338
----
340-
341339
hbase> disable 'test'
342340
hbase> alter 'test', {NAME => 'cf', COMPRESSION => 'GZ'}
343341
hbase> enable 'test'
344342
----
345-
====
346343
347344
.Creating a New Table with Compression On a ColumnFamily
348-
====
349345
----
350-
351346
hbase> create 'test2', { NAME => 'cf2', COMPRESSION => 'SNAPPY' }
352347
----
353-
====
354348
355349
.Verifying a ColumnFamily's Compression Settings
356-
====
357350
----
358351
359352
hbase> describe 'test'
@@ -366,17 +359,14 @@ DESCRIPTION ENABLED
366359
LOCKCACHE => 'true'}
367360
1 row(s) in 0.1070 seconds
368361
----
369-
====
370362
371363
==== Testing Compression Performance
372364
373365
HBase includes a tool called LoadTestTool which provides mechanisms to test your compression performance.
374366
You must specify either `-write` or `-update-read` as your first parameter, and if you do not specify another parameter, usage advice is printed for each option.
375367
376368
.+LoadTestTool+ Usage
377-
====
378369
----
379-
380370
$ bin/hbase org.apache.hadoop.hbase.util.LoadTestTool -h
381371
usage: bin/hbase org.apache.hadoop.hbase.util.LoadTestTool <options>
382372
Options:
@@ -429,16 +419,12 @@ Options:
429419
port numbers
430420
-zk_root <arg> name of parent znode in zookeeper
431421
----
432-
====
433422
434423
.Example Usage of LoadTestTool
435-
====
436424
----
437-
438425
$ hbase org.apache.hadoop.hbase.util.LoadTestTool -write 1:10:100 -num_keys 1000000
439426
-read 100:30 -num_tables 1 -data_block_encoding NONE -tn load_test_tool_NONE
440427
----
441-
====
442428
443429
[[data.block.encoding.enable]]
444430
=== Enable Data Block Encoding
@@ -449,9 +435,7 @@ Disable the table before altering its DATA_BLOCK_ENCODING setting.
449435
Following is an example using HBase Shell:
450436
451437
.Enable Data Block Encoding On a Table
452-
====
453438
----
454-
455439
hbase> disable 'test'
456440
hbase> alter 'test', { NAME => 'cf', DATA_BLOCK_ENCODING => 'FAST_DIFF' }
457441
Updating all regions with the new schema...
@@ -462,12 +446,9 @@ Done.
462446
hbase> enable 'test'
463447
0 row(s) in 0.1580 seconds
464448
----
465-
====
466449
467450
.Verifying a ColumnFamily's Data Block Encoding
468-
====
469451
----
470-
471452
hbase> describe 'test'
472453
DESCRIPTION ENABLED
473454
'test', {NAME => 'cf', DATA_BLOCK_ENCODING => 'FAST true
@@ -478,7 +459,6 @@ DESCRIPTION ENABLED
478459
e', BLOCKCACHE => 'true'}
479460
1 row(s) in 0.0650 seconds
480461
----
481-
====
482462
483463
:numbered:
484464

src/main/asciidoc/_chapters/getting_started.adoc

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -604,36 +604,29 @@ On each node of the cluster, run the `jps` command and verify that the correct p
604604
You may see additional Java processes running on your servers as well, if they are used for other purposes.
605605
+
606606
.`node-a` `jps` Output
607-
====
608607
----
609-
610608
$ jps
611609
20355 Jps
612610
20071 HQuorumPeer
613611
20137 HMaster
614612
----
615-
====
616613
+
617614
.`node-b` `jps` Output
618-
====
619615
----
620616
$ jps
621617
15930 HRegionServer
622618
16194 Jps
623619
15838 HQuorumPeer
624620
16010 HMaster
625621
----
626-
====
627622
+
628623
.`node-c` `jps` Output
629-
====
630624
----
631625
$ jps
632626
13901 Jps
633627
13639 HQuorumPeer
634628
13737 HRegionServer
635629
----
636-
====
637630
+
638631
.ZooKeeper Process Name
639632
[NOTE]

src/main/asciidoc/_chapters/hbase_mob.adoc

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,10 @@ an object is considered to be a MOB. Only `IS_MOB` is required. If you do not
6161
specify the `MOB_THRESHOLD`, the default threshold value of 100 KB is used.
6262

6363
.Configure a Column for MOB Using HBase Shell
64-
====
6564
----
6665
hbase> create 't1', {NAME => 'f1', IS_MOB => true, MOB_THRESHOLD => 102400}
6766
hbase> alter 't1', {NAME => 'f1', IS_MOB => true, MOB_THRESHOLD => 102400}
6867
----
69-
====
7068

7169
.Configure a Column for MOB Using the Java API
7270
====
@@ -91,7 +89,6 @@ weekly policy - compact MOB Files for one week into one large MOB file
9189
montly policy - compact MOB Files for one month into one large MOB File
9290

9391
.Configure MOB compaction policy Using HBase Shell
94-
====
9592
----
9693
hbase> create 't1', {NAME => 'f1', IS_MOB => true, MOB_THRESHOLD => 102400, MOB_COMPACT_PARTITION_POLICY => 'daily'}
9794
hbase> create 't1', {NAME => 'f1', IS_MOB => true, MOB_THRESHOLD => 102400, MOB_COMPACT_PARTITION_POLICY => 'weekly'}
@@ -101,7 +98,6 @@ hbase> alter 't1', {NAME => 'f1', IS_MOB => true, MOB_THRESHOLD => 102400, MOB_C
10198
hbase> alter 't1', {NAME => 'f1', IS_MOB => true, MOB_THRESHOLD => 102400, MOB_COMPACT_PARTITION_POLICY => 'weekly'}
10299
hbase> alter 't1', {NAME => 'f1', IS_MOB => true, MOB_THRESHOLD => 102400, MOB_COMPACT_PARTITION_POLICY => 'monthly'}
103100
----
104-
====
105101

106102
=== Configure MOB Compaction mergeable threshold
107103

src/main/asciidoc/_chapters/ops_mgt.adoc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1023,13 +1023,10 @@ The script requires you to set some environment variables before running it.
10231023
Examine the script and modify it to suit your needs.
10241024

10251025
._rolling-restart.sh_ General Usage
1026-
====
10271026
----
1028-
10291027
$ ./bin/rolling-restart.sh --help
10301028
Usage: rolling-restart.sh [--config <hbase-confdir>] [--rs-only] [--master-only] [--graceful] [--maxthreads xx]
10311029
----
1032-
====
10331030

10341031
Rolling Restart on RegionServers Only::
10351032
To perform a rolling restart on the RegionServers only, use the `--rs-only` option.

src/main/asciidoc/_chapters/performance.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -188,11 +188,9 @@ It is useful for tuning the IO impact of prefetching versus the time before all
188188
To enable prefetching on a given column family, you can use HBase Shell or use the API.
189189
190190
.Enable Prefetch Using HBase Shell
191-
====
192191
----
193192
hbase> create 'MyTable', { NAME => 'myCF', PREFETCH_BLOCKS_ON_OPEN => 'true' }
194193
----
195-
====
196194
197195
.Enable Prefetch Using the API
198196
====

src/main/asciidoc/_chapters/schema_design.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -504,11 +504,9 @@ Deleted cells are still subject to TTL and there will never be more than "maximu
504504
A new "raw" scan options returns all deleted rows and the delete markers.
505505
506506
.Change the Value of `KEEP_DELETED_CELLS` Using HBase Shell
507-
====
508507
----
509508
hbase> hbase> alter ‘t1′, NAME => ‘f1′, KEEP_DELETED_CELLS => true
510509
----
511-
====
512510
513511
.Change the Value of `KEEP_DELETED_CELLS` Using the API
514512
====

src/main/asciidoc/_chapters/security.adoc

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1086,15 +1086,13 @@ public static void revokeFromTable(final HBaseTestingUtility util, final String
10861086
. Showing a User's Effective Permissions
10871087
+
10881088
.HBase Shell
1089-
====
10901089
----
10911090
hbase> user_permission 'user'
10921091
10931092
hbase> user_permission '.*'
10941093
10951094
hbase> user_permission JAVA_REGEX
10961095
----
1097-
====
10981096

10991097
.API
11001098
====
@@ -1234,11 +1232,9 @@ Refer to the official API for usage instructions.
12341232
. Define the List of Visibility Labels
12351233
+
12361234
.HBase Shell
1237-
====
12381235
----
12391236
hbase> add_labels [ 'admin', 'service', 'developer', 'test' ]
12401237
----
1241-
====
12421238
+
12431239
.Java API
12441240
====
@@ -1265,7 +1261,6 @@ public static void addLabels() throws Exception {
12651261
. Associate Labels with Users
12661262
+
12671263
.HBase Shell
1268-
====
12691264
----
12701265
hbase> set_auths 'service', [ 'service' ]
12711266
----
@@ -1281,7 +1276,6 @@ hbase> set_auths 'qa', [ 'test', 'developer' ]
12811276
----
12821277
hbase> set_auths '@qagroup', [ 'test' ]
12831278
----
1284-
====
12851279
+
12861280
.Java API
12871281
====
@@ -1305,7 +1299,6 @@ public void testSetAndGetUserAuths() throws Throwable {
13051299
. Clear Labels From Users
13061300
+
13071301
.HBase Shell
1308-
====
13091302
----
13101303
hbase> clear_auths 'service', [ 'service' ]
13111304
----
@@ -1321,7 +1314,6 @@ hbase> clear_auths 'qa', [ 'test', 'developer' ]
13211314
----
13221315
hbase> clear_auths '@qagroup', [ 'test', 'developer' ]
13231316
----
1324-
====
13251317
+
13261318
.Java API
13271319
====
@@ -1345,7 +1337,6 @@ The label is only applied when data is written.
13451337
The label is associated with a given version of the cell.
13461338
+
13471339
.HBase Shell
1348-
====
13491340
----
13501341
hbase> set_visibility 'user', 'admin|service|developer', { COLUMNS => 'i' }
13511342
----
@@ -1357,7 +1348,6 @@ hbase> set_visibility 'user', 'admin|service', { COLUMNS => 'pii' }
13571348
----
13581349
hbase> set_visibility 'user', 'test', { COLUMNS => [ 'i', 'pii' ], FILTER => "(PrefixFilter ('test'))" }
13591350
----
1360-
====
13611351
+
13621352
NOTE: HBase Shell support for applying labels or permissions to cells is for testing and verification support, and should not be employed for production use because it won't apply the labels to cells that don't exist yet.
13631353
The correct way to apply cell level labels is to do so in the application code when storing the values.
@@ -1408,12 +1398,10 @@ set as an additional filter. It will further filter your results, rather than
14081398
giving you additional authorization.
14091399

14101400
.HBase Shell
1411-
====
14121401
----
14131402
hbase> get_auths 'myUser'
14141403
hbase> scan 'table1', AUTHORIZATIONS => ['private']
14151404
----
1416-
====
14171405

14181406
.Java API
14191407
====

src/main/asciidoc/_chapters/shell.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,6 @@ For instance, if your script creates a table, but returns a non-zero exit value,
145145
You can enter HBase Shell commands into a text file, one command per line, and pass that file to the HBase Shell.
146146

147147
.Example Command File
148-
====
149148
----
150149
create 'test', 'cf'
151150
list 'test'
@@ -158,7 +157,6 @@ get 'test', 'row1'
158157
disable 'test'
159158
enable 'test'
160159
----
161-
====
162160

163161
.Directing HBase Shell to Execute the Commands
164162
====

0 commit comments

Comments
 (0)