This is an automated email from the ASF dual-hosted git repository.
alexey pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/kudu.git
The following commit(s) were added to refs/heads/master by this push:
new 7d1f3fb [C++ client] doxygenized C++ client API in
columnar_scan_batch.h
7d1f3fb is described below
commit 7d1f3fbb40984b6917e6e76f252bf6a0924fd70d
Author: hahao <[email protected]>
AuthorDate: Thu May 14 15:28:21 2020 -0700
[C++ client] doxygenized C++ client API in columnar_scan_batch.h
This patch documents the missing parameters for APIs in
columnar_scan_batch.h
to satisfy the warnings from doxygen.
Change-Id: Ifb8b927bf55ff181b9923411c35729eed8bafa08
Reviewed-on: http://gerrit.cloudera.org:8080/15918
Reviewed-by: Grant Henke <[email protected]>
Tested-by: Kudu Jenkins
Reviewed-by: Alexey Serbin <[email protected]>
---
src/kudu/client/columnar_scan_batch.h | 41 ++++++++++++++++++++++++-----------
1 file changed, 28 insertions(+), 13 deletions(-)
diff --git a/src/kudu/client/columnar_scan_batch.h
b/src/kudu/client/columnar_scan_batch.h
index 924c162..953ce8b 100644
--- a/src/kudu/client/columnar_scan_batch.h
+++ b/src/kudu/client/columnar_scan_batch.h
@@ -58,35 +58,50 @@ class KUDU_EXPORT KuduColumnarScanBatch {
/// Get the raw columnar data corresponding to the primitive-typed column
with index 'idx'.
///
- /// The data is in little-endian packed array format. No alignment or
padding is guaranteed.
- /// Space is reserved for all cells regardless of whether they might be null.
- /// The data stored in a null cell may or may not be zeroed.
- ///
/// For variable-length (e.g. STRING, BINARY, VARCHAR) columns, use
/// GetVariableLengthColumn instead.
///
/// @note The Slice returned is only valid for the lifetime of the
KuduColumnarScanBatch.
+ ///
+ /// @param [in] idx
+ /// The column index.
+ /// @param [out] data
+ /// The data is in little-endian packed array format. No alignment or
padding is guaranteed.
+ /// Space is reserved for all cells regardless of whether they might be
null.
+ /// The data stored in a null cell may or may not be zeroed.
+ /// @return Operation result status.
Status GetFixedLengthColumn(int idx, Slice* data) const;
/// Return the variable-length data for the variable-length-typed column
with index 'idx'.
///
- /// If NumRows() is 0, the 'offsets' array will have length 0. Otherwise,
this array
- /// will contain NumRows() + 1 entries, each indicating an offset within the
- /// variable-length data array returned in 'data'. For each cell with index
'n',
- /// offsets[n] indicates the starting offset of that cell, and offsets[n+1]
indicates
- /// the ending offset of that cell.
+ /// @param [in] idx
+ /// The column index.
+ /// @param [out] offsets
+ /// If NumRows() is 0, the 'offsets' array will have length 0. Otherwise,
this array
+ /// will contain NumRows() + 1 entries, each indicating an offset within
the
+ /// variable-length data array returned in 'data'. For each cell with
index 'n',
+ /// offsets[n] indicates the starting offset of that cell, and
offsets[n+1] indicates
+ /// the ending offset of that cell.
+ /// @param [out] data
+ /// The variable-length data.
+ /// @return Operation result status.
Status GetVariableLengthColumn(int idx, Slice* offsets, Slice* data) const;
/// Get a bitmap corresponding to the non-null status of the cells in the
given column.
///
- /// A set bit indicates a non-null cell.
- /// If the number of rows is not a multiple of 8, the state of the trailing
bits in the
- /// bitmap is undefined.
- ///
/// It is an error to call this function on a column which is not marked as
nullable
/// in the schema.
///
/// @note The Slice returned is only valid for the lifetime of the
KuduColumnarScanBatch.
+ ///
+ /// @param [in] idx
+ /// The column index.
+ /// @param [out] data
+ /// The bitmap corresponding to the non-null status of the cells in the
given column.
+ /// A set bit indicates a non-null cell.
+ /// If the number of rows is not a multiple of 8, the state of the
trailing bits in the
+ /// bitmap is undefined.
+ /// @return Operation result status.
Status GetNonNullBitmapForColumn(int idx, Slice* data) const;
private:
