-
Notifications
You must be signed in to change notification settings - Fork 3
/
Hbase.thrift
1019 lines (856 loc) · 25.2 KB
/
Hbase.thrift
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// ----------------------------------------------------------------
// Hbase.thrift
//
// This is a Thrift interface definition file for the Hbase service.
// Target language libraries for C++, Java, Ruby, PHP, (and more) are
// generated by running this file through the Thrift compiler with the
// appropriate flags. The Thrift compiler binary and runtime
// libraries for various languages are available
// from the Apache Incubator (http://incubator.apache.org/thrift/)
//
// See the package.html file for information on the version of Thrift
// used to generate the *.java files checked into the Hbase project.
// ----------------------------------------------------------------
namespace java org.apache.hadoop.hbase.thrift.generated
namespace cpp apache.hadoop.hbase.thrift
namespace rb Apache.Hadoop.Hbase.Thrift
namespace py hbase
namespace perl Hbase
namespace php Hbase
//
// Types
//
// NOTE: all variables with the Text type are assumed to be correctly
// formatted UTF-8 strings. This is a programming language and locale
// dependent property that the client application is repsonsible for
// maintaining. If strings with an invalid encoding are sent, an
// IOError will be thrown.
typedef binary Text
typedef binary Bytes
typedef i32 ScannerID
/**
* TCell - Used to transport a cell value (byte[]) and the timestamp it was
* stored with together as a result for get and getRow methods. This promotes
* the timestamp of a cell to a first-class value, making it easy to take
* note of temporal data. Cell is used all the way from HStore up to HTable.
*/
struct TCell{
1:Bytes value,
2:i64 timestamp
}
/**
* An HColumnDescriptor contains information about a column family
* such as the number of versions, compression settings, etc. It is
* used as input when creating a table or adding a column.
*/
struct ColumnDescriptor {
1:Text name,
2:i32 maxVersions = 3,
3:string compression = "NONE",
4:bool inMemory = 0,
5:string bloomFilterType = "NONE",
6:i32 bloomFilterVectorSize = 0,
7:i32 bloomFilterNbHashes = 0,
8:bool blockCacheEnabled = 0,
9:i32 timeToLive = 0x7fffffff
}
/**
* A TRegionInfo contains information about an HTable region.
*/
struct TRegionInfo {
1:Text startKey,
2:Text endKey,
3:i64 id,
4:Text name,
5:byte version,
6:Text serverName,
7:i32 port
}
/**
* A Mutation object is used to either update or delete a column-value.
*/
struct Mutation {
1:bool isDelete = 0,
2:Text column,
3:Text value,
4:bool writeToWAL = 1
}
/**
* A BatchMutation object is used to apply a number of Mutations to a single row.
*/
struct BatchMutation {
1:Text row,
2:list<Mutation> mutations
}
/**
* For increments that are not incrementColumnValue
* equivalents.
*/
struct TIncrement {
1:Text table,
2:Text row,
3:Text column,
4:i64 ammount
}
/**
* Holds column name and the cell.
*/
struct TColumn {
1:Text columnName,
2:TCell cell
}
/**
* Holds row name and then a map of columns to cells.
*/
struct TRowResult {
1:Text row,
2:optional map<Text, TCell> columns,
3:optional list<TColumn> sortedColumns
}
/**
* A Scan object is used to specify scanner parameters when opening a scanner.
*/
struct TScan {
1:optional Text startRow,
2:optional Text stopRow,
3:optional i64 timestamp,
4:optional list<Text> columns,
5:optional i32 caching,
6:optional Text filterString,
7:optional i32 batchSize,
8:optional bool sortColumns,
9:optional bool reversed,
10:optional bool cacheBlocks
}
/**
* An Append object is used to specify the parameters for performing the append operation.
*/
struct TAppend {
1:Text table,
2:Text row,
3:list<Text> columns,
4:list<Text> values
}
//
// Exceptions
//
/**
* An IOError exception signals that an error occurred communicating
* to the Hbase master or an Hbase region server. Also used to return
* more general Hbase error conditions.
*/
exception IOError {
1:string message
2:bool canRetry
}
/**
* An IllegalArgument exception indicates an illegal or invalid
* argument was passed into a procedure.
*/
exception IllegalArgument {
1:string message
}
/**
* An AlreadyExists exceptions signals that a table with the specified
* name already exists
*/
exception AlreadyExists {
1:string message
}
/**
* Specify type of thrift server: thrift and thrift2
*/
enum TThriftServerType {
ONE = 1,
TWO = 2
}
enum TPermissionScope {
TABLE = 0,
NAMESPACE = 1
}
/**
* TAccessControlEntity for permission control
*/
struct TAccessControlEntity {
1: required string username
2: required TPermissionScope scope
4: required string actions
5: optional Bytes tableName
6: optional string nsName
}
//
// Service
//
service Hbase {
/**
* Brings a table on-line (enables it)
*/
void enableTable(
/** name of the table */
1:Bytes tableName
) throws (1:IOError io)
/**
* Disables a table (takes it off-line) If it is being served, the master
* will tell the servers to stop serving it.
*/
void disableTable(
/** name of the table */
1:Bytes tableName
) throws (1:IOError io)
/**
* @return true if table is on-line
*/
bool isTableEnabled(
/** name of the table to check */
1:Bytes tableName
) throws (1:IOError io)
void compact(1:Bytes tableNameOrRegionName)
throws (1:IOError io)
void majorCompact(1:Bytes tableNameOrRegionName)
throws (1:IOError io)
/**
* List all the userspace tables.
*
* @return returns a list of names
*/
list<Text> getTableNames()
throws (1:IOError io)
/**
* List all the userspace tables and their enabled or disabled flags.
*
* @return list of tables with is enabled flags
*/
map<Text,bool> getTableNamesWithIsTableEnabled()
throws (1:IOError io)
/**
* List all the column families assoicated with a table.
*
* @return list of column family descriptors
*/
map<Text,ColumnDescriptor> getColumnDescriptors (
/** table name */
1:Text tableName
) throws (1:IOError io)
/**
* List the regions associated with a table.
*
* @return list of region descriptors
*/
list<TRegionInfo> getTableRegions(
/** table name */
1:Text tableName)
throws (1:IOError io)
/**
* Create a table with the specified column families. The name
* field for each ColumnDescriptor must be set and must end in a
* colon (:). All other fields are optional and will get default
* values if not explicitly specified.
*
* @throws IllegalArgument if an input parameter is invalid
*
* @throws AlreadyExists if the table name already exists
*/
void createTable(
/** name of table to create */
1:Text tableName,
/** list of column family descriptors */
2:list<ColumnDescriptor> columnFamilies
) throws (1:IOError io, 2:IllegalArgument ia, 3:AlreadyExists exist)
/**
* Deletes a table
*
* @throws IOError if table doesn't exist on server or there was some other
* problem
*/
void deleteTable(
/** name of table to delete */
1:Text tableName
) throws (1:IOError io)
/**
* Get a single TCell for the specified table, row, and column at the
* latest timestamp. Returns an empty list if no such value exists.
*
* @return value for specified row/column
*/
list<TCell> get(
/** name of table */
1:Text tableName,
/** row key */
2:Text row,
/** column name */
3:Text column,
/** Get attributes */
4:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Get the specified number of versions for the specified table,
* row, and column.
*
* @return list of cells for specified row/column
*/
list<TCell> getVer(
/** name of table */
1:Text tableName,
/** row key */
2:Text row,
/** column name */
3:Text column,
/** number of versions to retrieve */
4:i32 numVersions,
/** Get attributes */
5:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Get the specified number of versions for the specified table,
* row, and column. Only versions less than or equal to the specified
* timestamp will be returned.
*
* @return list of cells for specified row/column
*/
list<TCell> getVerTs(
/** name of table */
1:Text tableName,
/** row key */
2:Text row,
/** column name */
3:Text column,
/** timestamp */
4:i64 timestamp,
/** number of versions to retrieve */
5:i32 numVersions,
/** Get attributes */
6:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Get all the data for the specified table and row at the latest
* timestamp. Returns an empty list if the row does not exist.
*
* @return TRowResult containing the row and map of columns to TCells
*/
list<TRowResult> getRow(
/** name of table */
1:Text tableName,
/** row key */
2:Text row,
/** Get attributes */
3:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Get the specified columns for the specified table and row at the latest
* timestamp. Returns an empty list if the row does not exist.
*
* @return TRowResult containing the row and map of columns to TCells
*/
list<TRowResult> getRowWithColumns(
/** name of table */
1:Text tableName,
/** row key */
2:Text row,
/** List of columns to return, null for all columns */
3:list<Text> columns,
/** Get attributes */
4:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Get all the data for the specified table and row at the specified
* timestamp. Returns an empty list if the row does not exist.
*
* @return TRowResult containing the row and map of columns to TCells
*/
list<TRowResult> getRowTs(
/** name of the table */
1:Text tableName,
/** row key */
2:Text row,
/** timestamp */
3:i64 timestamp,
/** Get attributes */
4:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Get the specified columns for the specified table and row at the specified
* timestamp. Returns an empty list if the row does not exist.
*
* @return TRowResult containing the row and map of columns to TCells
*/
list<TRowResult> getRowWithColumnsTs(
/** name of table */
1:Text tableName,
/** row key */
2:Text row,
/** List of columns to return, null for all columns */
3:list<Text> columns,
4:i64 timestamp,
/** Get attributes */
5:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Get all the data for the specified table and rows at the latest
* timestamp. Returns an empty list if no rows exist.
*
* @return TRowResult containing the rows and map of columns to TCells
*/
list<TRowResult> getRows(
/** name of table */
1:Text tableName,
/** row keys */
2:list<Text> rows
/** Get attributes */
3:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Get the specified columns for the specified table and rows at the latest
* timestamp. Returns an empty list if no rows exist.
*
* @return TRowResult containing the rows and map of columns to TCells
*/
list<TRowResult> getRowsWithColumns(
/** name of table */
1:Text tableName,
/** row keys */
2:list<Text> rows,
/** List of columns to return, null for all columns */
3:list<Text> columns,
/** Get attributes */
4:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Get all the data for the specified table and rows at the specified
* timestamp. Returns an empty list if no rows exist.
*
* @return TRowResult containing the rows and map of columns to TCells
*/
list<TRowResult> getRowsTs(
/** name of the table */
1:Text tableName,
/** row keys */
2:list<Text> rows
/** timestamp */
3:i64 timestamp,
/** Get attributes */
4:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Get the specified columns for the specified table and rows at the specified
* timestamp. Returns an empty list if no rows exist.
*
* @return TRowResult containing the rows and map of columns to TCells
*/
list<TRowResult> getRowsWithColumnsTs(
/** name of table */
1:Text tableName,
/** row keys */
2:list<Text> rows
/** List of columns to return, null for all columns */
3:list<Text> columns,
4:i64 timestamp,
/** Get attributes */
5:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Apply a series of mutations (updates/deletes) to a row in a
* single transaction. If an exception is thrown, then the
* transaction is aborted. Default current timestamp is used, and
* all entries will have an identical timestamp.
*/
void mutateRow(
/** name of table */
1:Text tableName,
/** row key */
2:Text row,
/** list of mutation commands */
3:list<Mutation> mutations,
/** Mutation attributes */
4:map<Text, Text> attributes
) throws (1:IOError io, 2:IllegalArgument ia)
/**
* Apply a series of mutations (updates/deletes) to a row in a
* single transaction. If an exception is thrown, then the
* transaction is aborted. The specified timestamp is used, and
* all entries will have an identical timestamp.
*/
void mutateRowTs(
/** name of table */
1:Text tableName,
/** row key */
2:Text row,
/** list of mutation commands */
3:list<Mutation> mutations,
/** timestamp */
4:i64 timestamp,
/** Mutation attributes */
5:map<Text, Text> attributes
) throws (1:IOError io, 2:IllegalArgument ia)
/**
* Apply a series of batches (each a series of mutations on a single row)
* in a single transaction. If an exception is thrown, then the
* transaction is aborted. Default current timestamp is used, and
* all entries will have an identical timestamp.
*/
void mutateRows(
/** name of table */
1:Text tableName,
/** list of row batches */
2:list<BatchMutation> rowBatches,
/** Mutation attributes */
3:map<Text, Text> attributes
) throws (1:IOError io, 2:IllegalArgument ia)
/**
* Apply a series of batches (each a series of mutations on a single row)
* in a single transaction. If an exception is thrown, then the
* transaction is aborted. The specified timestamp is used, and
* all entries will have an identical timestamp.
*/
void mutateRowsTs(
/** name of table */
1:Text tableName,
/** list of row batches */
2:list<BatchMutation> rowBatches,
/** timestamp */
3:i64 timestamp,
/** Mutation attributes */
4:map<Text, Text> attributes
) throws (1:IOError io, 2:IllegalArgument ia)
/**
* Atomically increment the column value specified. Returns the next value post increment.
*/
i64 atomicIncrement(
/** name of table */
1:Text tableName,
/** row to increment */
2:Text row,
/** name of column */
3:Text column,
/** amount to increment by */
4:i64 value
) throws (1:IOError io, 2:IllegalArgument ia)
/**
* Delete all cells that match the passed row and column.
*/
void deleteAll(
/** name of table */
1:Text tableName,
/** Row to update */
2:Text row,
/** name of column whose value is to be deleted */
3:Text column,
/** Delete attributes */
4:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Delete all cells that match the passed row and column and whose
* timestamp is equal-to or older than the passed timestamp.
*/
void deleteAllTs(
/** name of table */
1:Text tableName,
/** Row to update */
2:Text row,
/** name of column whose value is to be deleted */
3:Text column,
/** timestamp */
4:i64 timestamp,
/** Delete attributes */
5:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Completely delete the row's cells.
*/
void deleteAllRow(
/** name of table */
1:Text tableName,
/** key of the row to be completely deleted. */
2:Text row,
/** Delete attributes */
3:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Increment a cell by the ammount.
* Increments can be applied async if hbase.regionserver.thrift.coalesceIncrement is set to true.
* False is the default. Turn to true if you need the extra performance and can accept some
* data loss if a thrift server dies with increments still in the queue.
*/
void increment(
/** The single increment to apply */
1:TIncrement increment
) throws (1:IOError io)
void incrementRows(
/** The list of increments */
1:list<TIncrement> increments
) throws (1:IOError io)
/**
* Completely delete the row's cells marked with a timestamp
* equal-to or older than the passed timestamp.
*/
void deleteAllRowTs(
/** name of table */
1:Text tableName,
/** key of the row to be completely deleted. */
2:Text row,
/** timestamp */
3:i64 timestamp,
/** Delete attributes */
4:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Get a scanner on the current table, using the Scan instance
* for the scan parameters.
*/
ScannerID scannerOpenWithScan(
/** name of table */
1:Text tableName,
/** Scan instance */
2:TScan scan,
/** Scan attributes */
3:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Get a scanner on the current table starting at the specified row and
* ending at the last row in the table. Return the specified columns.
*
* @return scanner id to be used with other scanner procedures
*/
ScannerID scannerOpen(
/** name of table */
1:Text tableName,
/**
* Starting row in table to scan.
* Send "" (empty string) to start at the first row.
*/
2:Text startRow,
/**
* columns to scan. If column name is a column family, all
* columns of the specified column family are returned. It's also possible
* to pass a regex in the column qualifier.
*/
3:list<Text> columns,
/** Scan attributes */
4:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Get a scanner on the current table starting and stopping at the
* specified rows. ending at the last row in the table. Return the
* specified columns.
*
* @return scanner id to be used with other scanner procedures
*/
ScannerID scannerOpenWithStop(
/** name of table */
1:Text tableName,
/**
* Starting row in table to scan.
* Send "" (empty string) to start at the first row.
*/
2:Text startRow,
/**
* row to stop scanning on. This row is *not* included in the
* scanner's results
*/
3:Text stopRow,
/**
* columns to scan. If column name is a column family, all
* columns of the specified column family are returned. It's also possible
* to pass a regex in the column qualifier.
*/
4:list<Text> columns,
/** Scan attributes */
5:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Open a scanner for a given prefix. That is all rows will have the specified
* prefix. No other rows will be returned.
*
* @return scanner id to use with other scanner calls
*/
ScannerID scannerOpenWithPrefix(
/** name of table */
1:Text tableName,
/** the prefix (and thus start row) of the keys you want */
2:Text startAndPrefix,
/** the columns you want returned */
3:list<Text> columns,
/** Scan attributes */
4:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Get a scanner on the current table starting at the specified row and
* ending at the last row in the table. Return the specified columns.
* Only values with the specified timestamp are returned.
*
* @return scanner id to be used with other scanner procedures
*/
ScannerID scannerOpenTs(
/** name of table */
1:Text tableName,
/**
* Starting row in table to scan.
* Send "" (empty string) to start at the first row.
*/
2:Text startRow,
/**
* columns to scan. If column name is a column family, all
* columns of the specified column family are returned. It's also possible
* to pass a regex in the column qualifier.
*/
3:list<Text> columns,
/** timestamp */
4:i64 timestamp,
/** Scan attributes */
5:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Get a scanner on the current table starting and stopping at the
* specified rows. ending at the last row in the table. Return the
* specified columns. Only values with the specified timestamp are
* returned.
*
* @return scanner id to be used with other scanner procedures
*/
ScannerID scannerOpenWithStopTs(
/** name of table */
1:Text tableName,
/**
* Starting row in table to scan.
* Send "" (empty string) to start at the first row.
*/
2:Text startRow,
/**
* row to stop scanning on. This row is *not* included in the
* scanner's results
*/
3:Text stopRow,
/**
* columns to scan. If column name is a column family, all
* columns of the specified column family are returned. It's also possible
* to pass a regex in the column qualifier.
*/
4:list<Text> columns,
/** timestamp */
5:i64 timestamp,
/** Scan attributes */
6:map<Text, Text> attributes
) throws (1:IOError io)
/**
* Returns the scanner's current row value and advances to the next
* row in the table. When there are no more rows in the table, or a key
* greater-than-or-equal-to the scanner's specified stopRow is reached,
* an empty list is returned.
*
* @return a TRowResult containing the current row and a map of the columns to TCells.
*
* @throws IllegalArgument if ScannerID is invalid
*
* @throws NotFound when the scanner reaches the end
*/
list<TRowResult> scannerGet(
/** id of a scanner returned by scannerOpen */
1:ScannerID id
) throws (1:IOError io, 2:IllegalArgument ia)
/**
* Returns, starting at the scanner's current row value nbRows worth of
* rows and advances to the next row in the table. When there are no more
* rows in the table, or a key greater-than-or-equal-to the scanner's
* specified stopRow is reached, an empty list is returned.
*
* @return a TRowResult containing the current row and a map of the columns to TCells.
*
* @throws IllegalArgument if ScannerID is invalid
*
* @throws NotFound when the scanner reaches the end
*/
list<TRowResult> scannerGetList(
/** id of a scanner returned by scannerOpen */
1:ScannerID id,
/** number of results to return */
2:i32 nbRows
) throws (1:IOError io, 2:IllegalArgument ia)
/**
* Closes the server-state associated with an open scanner.
*
* @throws IllegalArgument if ScannerID is invalid
*/
void scannerClose(
/** id of a scanner returned by scannerOpen */
1:ScannerID id
) throws (1:IOError io, 2:IllegalArgument ia)
/**
* Get the regininfo for the specified row. It scans
* the metatable to find region's start and end keys.
*
* @return value for specified row/column
*/
TRegionInfo getRegionInfo(
/** row key */
1:Text row,
) throws (1:IOError io)
/**
* Appends values to one or more columns within a single row.
*
* @return values of columns after the append operation.
*/
list<TCell> append(
/** The single append operation to apply */
1:TAppend append,
) throws (1:IOError io)
/**
* Atomically checks if a row/family/qualifier value matches the expected
* value. If it does, it adds the corresponding mutation operation for put.
*
* @return true if the new put was executed, false otherwise
*/
bool checkAndPut(
/** name of table */
1:Text tableName,
/** row key */
2:Text row,
/** column name */
3:Text column,
/** the expected value for the column parameter, if not
provided the check is for the non-existence of the
column in question */
5:Text value
/** mutation for the put */
6:Mutation mput,
/** Mutation attributes */
7:map<Text, Text> attributes
) throws (1:IOError io, 2:IllegalArgument ia)
/**
* Get the type of this thrift server.
*
* @return the type of this thrift server
*/
TThriftServerType getThriftServerType()