You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kudu.apache.org by al...@apache.org on 2018/10/25 04:05:57 UTC
[1/2] kudu git commit: [c++ client] KuduTable::ListPartitions() is
private API
Repository: kudu
Updated Branches:
refs/heads/master 7f4a1a628 -> a30c9211e
[c++ client] KuduTable::ListPartitions() is private API
Added missing KUDU_NO_EXPORT attribute for KuduTable::ListPartitions()
since the method is indented to be a part of private (i.e. non-exported)
API of the Kudu C++ client.
This is a follow-up for ef714838a8ba4e2a0dbf1d2f7998f8909d591402.
Change-Id: Iaaeeda02a8b97e7b963f9f4496e879f999a0d97d
Reviewed-on: http://gerrit.cloudera.org:8080/11779
Tested-by: Alexey Serbin <as...@cloudera.com>
Reviewed-by: Adar Dembo <ad...@cloudera.com>
Project: http://git-wip-us.apache.org/repos/asf/kudu/repo
Commit: http://git-wip-us.apache.org/repos/asf/kudu/commit/9db90210
Tree: http://git-wip-us.apache.org/repos/asf/kudu/tree/9db90210
Diff: http://git-wip-us.apache.org/repos/asf/kudu/diff/9db90210
Branch: refs/heads/master
Commit: 9db90210522e66b665a792e2f710c9d8d63d713c
Parents: 7f4a1a6
Author: Alexey Serbin <as...@cloudera.com>
Authored: Wed Oct 24 17:56:01 2018 -0700
Committer: Alexey Serbin <as...@cloudera.com>
Committed: Thu Oct 25 04:02:26 2018 +0000
----------------------------------------------------------------------
src/kudu/client/client.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/kudu/blob/9db90210/src/kudu/client/client.h
----------------------------------------------------------------------
diff --git a/src/kudu/client/client.h b/src/kudu/client/client.h
index 5335e00..bcb7ada 100644
--- a/src/kudu/client/client.h
+++ b/src/kudu/client/client.h
@@ -1062,7 +1062,7 @@ class KUDU_EXPORT KuduTable : public sp::enable_shared_from_this<KuduTable> {
/// @param [out] partitions
/// The list of partitions of the table.
/// @return Status object for the operation.
- Status ListPartitions(std::vector<Partition>* partitions);
+ Status ListPartitions(std::vector<Partition>* partitions) KUDU_NO_EXPORT;
/// @end cond
[2/2] kudu git commit: [c++ client] clean up inline doxygen
documentation
Posted by al...@apache.org.
[c++ client] clean up inline doxygen documentation
This patch cleans up doxygen documentation in client.h.
Most importantly, this patch removes the internal API
methods (i.e. methods marked with KUDU_NO_EXPORT attribute)
from the auto-generated documentation. Fixed other typos
and mistakes in doxygen formatting, so now doxygen outputs
less warnings.
The rest of the doxygen warnings will be addressed in a follow-up
patch.
Change-Id: Ib0038f45e746896b6abbcfaa5741760218d7a9ad
Reviewed-on: http://gerrit.cloudera.org:8080/11780
Tested-by: Kudu Jenkins
Reviewed-by: Adar Dembo <ad...@cloudera.com>
Project: http://git-wip-us.apache.org/repos/asf/kudu/repo
Commit: http://git-wip-us.apache.org/repos/asf/kudu/commit/a30c9211
Tree: http://git-wip-us.apache.org/repos/asf/kudu/tree/a30c9211
Diff: http://git-wip-us.apache.org/repos/asf/kudu/diff/a30c9211
Branch: refs/heads/master
Commit: a30c9211e8e73ead70acdb6108e5a0eac90cb5cb
Parents: 9db9021
Author: Alexey Serbin <as...@cloudera.com>
Authored: Wed Oct 24 17:52:32 2018 -0700
Committer: Alexey Serbin <as...@cloudera.com>
Committed: Thu Oct 25 04:03:24 2018 +0000
----------------------------------------------------------------------
src/kudu/client/client.h | 78 ++++++++++++++++++++++++++++++-------------
1 file changed, 55 insertions(+), 23 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/kudu/blob/a30c9211/src/kudu/client/client.h
----------------------------------------------------------------------
diff --git a/src/kudu/client/client.h b/src/kudu/client/client.h
index bcb7ada..d759a26 100644
--- a/src/kudu/client/client.h
+++ b/src/kudu/client/client.h
@@ -339,8 +339,12 @@ class KUDU_EXPORT KuduClient : public sp::enable_shared_from_this<KuduClient> {
/// @return Operation status.
Status DeleteTable(const std::string& table_name);
+ /// @cond PRIVATE_API
+
/// Delete/drop a table in internal catalogs and possibly external catalogs.
///
+ /// Private API.
+ ///
/// @param [in] table_name
/// Name of the table to drop.
/// @param [in] modify_external_catalogs
@@ -349,6 +353,7 @@ class KUDU_EXPORT KuduClient : public sp::enable_shared_from_this<KuduClient> {
/// @return Operation status.
Status DeleteTableInCatalogs(const std::string& table_name,
bool modify_external_catalogs) KUDU_NO_EXPORT;
+ /// @endcond
/// Create a KuduTableAlterer object.
///
@@ -431,7 +436,7 @@ class KUDU_EXPORT KuduClient : public sp::enable_shared_from_this<KuduClient> {
/// @return A new session object; caller is responsible for destroying it.
sp::shared_ptr<KuduSession> NewSession();
- /// @cond false
+ /// @cond PRIVATE_API
/// Get tablet information for a tablet by ID.
///
@@ -553,25 +558,35 @@ class KUDU_EXPORT KuduClient : public sp::enable_shared_from_this<KuduClient> {
/// @return Status object for the operation.
Status ExportAuthenticationCredentials(std::string* authn_creds) const;
- // @return the configured Hive Metastore URIs on the most recently connected to
- // leader master, or an empty string if the Hive Metastore integration is not
- // enabled.
+ /// @cond PRIVATE_API
+
+ /// Private API.
+ ///
+ /// @return the configured Hive Metastore URIs on the most recently connected to
+ /// leader master, or an empty string if the Hive Metastore integration is not
+ /// enabled.
std::string GetHiveMetastoreUris() const KUDU_NO_EXPORT;
- // @return the configured Hive Metastore SASL (Kerberos) configuration on the most
- // recently connected to leader master, or an arbitrary value if the Hive
- // Metastore integration is not enabled.
+ /// Private API.
+ ///
+ /// @return the configured Hive Metastore SASL (Kerberos) configuration on the most
+ /// recently connected to leader master, or an arbitrary value if the Hive
+ /// Metastore integration is not enabled.
bool GetHiveMetastoreSaslEnabled() const KUDU_NO_EXPORT;
- // @return a unique ID which identifies the Hive Metastore instance, if the
- // cluster is configured with the Hive Metastore integration, or an
- // arbitrary value if the Hive Metastore integration is not enabled.
- //
- // @note this is provided on a best-effort basis, as not all Hive Metastore
- // versions which Kudu is compatible with include the necessary APIs. See
- // HIVE-16452 for more info.
+ /// Private API.
+ ///
+ /// @note this is provided on a best-effort basis, as not all Hive Metastore
+ /// versions which Kudu is compatible with include the necessary APIs. See
+ /// HIVE-16452 for more info.
+ ///
+ /// @return a unique ID which identifies the Hive Metastore instance, if the
+ /// cluster is configured with the Hive Metastore integration, or an
+ /// arbitrary value if the Hive Metastore integration is not enabled.
std::string GetHiveMetastoreUuid() const KUDU_NO_EXPORT;
+ /// @endcond
+
private:
class KUDU_NO_EXPORT Data;
@@ -1051,7 +1066,7 @@ class KUDU_EXPORT KuduTable : public sp::enable_shared_from_this<KuduTable> {
/// @return The partition schema for the table.
const PartitionSchema& partition_schema() const;
- /// @cond false
+ /// @cond PRIVATE_API
/// List the partitions of this table in 'partitions'. This operation may
/// involve RPC roundtrips to the leader master, and has a timeout equal
@@ -1064,7 +1079,7 @@ class KUDU_EXPORT KuduTable : public sp::enable_shared_from_this<KuduTable> {
/// @return Status object for the operation.
Status ListPartitions(std::vector<Partition>* partitions) KUDU_NO_EXPORT;
- /// @end cond
+ /// @endcond
private:
class KUDU_NO_EXPORT Data;
@@ -1231,14 +1246,20 @@ class KUDU_EXPORT KuduTableAlterer {
/// @return Raw pointer to this alterer object.
KuduTableAlterer* wait(bool wait);
+ /// @cond PRIVATE_API
+
/// Whether to apply the alteration to external catalogs, such as the Hive
/// Metastore, which the Kudu master has been configured to integrate with.
///
+ /// Private API.
+ ///
/// @param [in] modify_external_catalogs
/// Whether to apply the alteration to external catalogs.
/// @return Raw pointer to this alterer object.
KuduTableAlterer* modify_external_catalogs(bool modify_external_catalogs) KUDU_NO_EXPORT;
+ /// @endcond
+
/// @return Status of the ALTER TABLE operation. The return value
/// may indicate an error in the alter operation,
/// or a misuse of the builder (e.g. add_column() with default_value=NULL).
@@ -2145,6 +2166,7 @@ class KUDU_EXPORT KuduScanner {
/// data for further decoding. Using KuduScanBatch::Row() might yield incorrect/corrupt
/// results and might even cause the client to crash.
static const uint64_t PAD_UNIXTIME_MICROS_TO_16_BYTES = 1 << 0;
+
/// Optionally set row format modifier flags.
///
/// If flags is RowFormatFlags::NO_FLAGS, then no modifications will be made to the row
@@ -2168,12 +2190,16 @@ class KUDU_EXPORT KuduScanner {
/// ... // Row data decoding and handling.
/// }
/// @endcode
+ ///
+ /// @param [in] flags
+ /// Row format modifier flags to set.
+ /// @return Operation result status.
Status SetRowFormatFlags(uint64_t flags);
///@}
/// Set the maximum number of rows the scanner should return.
///
- /// @param [in] rows
+ /// @param [in] limit
/// Limit on the number of rows to return.
/// @return Operation result status.
Status SetLimit(int64_t limit) WARN_UNUSED_RESULT;
@@ -2393,6 +2419,10 @@ class KUDU_EXPORT KuduPartitionerBuilder {
~KuduPartitionerBuilder();
/// Set the timeout used for building the Partitioner object.
+ ///
+ /// @param [in] timeout
+ /// The timeout to set.
+ /// @return Pointer to the result object.
KuduPartitionerBuilder* SetBuildTimeout(MonoDelta timeout);
/// Create a KuduPartitioner object for the specified table.
@@ -2411,6 +2441,8 @@ class KUDU_EXPORT KuduPartitionerBuilder {
/// This means that the resulting partitioner is not guaranteed to have
/// up-to-date partition information in the case that there has been
/// a recent change to the partitioning of the target table.
+ ///
+ /// @return Operation result status.
Status Build(KuduPartitioner** partitioner);
private:
class KUDU_NO_EXPORT Data;
@@ -2435,9 +2467,9 @@ class KUDU_EXPORT KuduPartitioner {
public:
~KuduPartitioner();
- /// Return the number of partitions known by this partitioner.
- /// The partition indices returned by @c PartitionRow are guaranteed
- /// to be less than this value.
+ /// @return the number of partitions known by this partitioner.
+ /// The partition indices returned by @c PartitionRow are guaranteed
+ /// to be less than this value.
int NumPartitions() const;
/// Determine the partition index that the given row falls into.
@@ -2448,9 +2480,9 @@ class KUDU_EXPORT KuduPartitioner {
/// The resulting partition index, or -1 if the row falls into a
/// non-covered range. The result will be less than @c NumPartitioons().
///
- /// @return Status OK if successful. May return a bad Status if the
- /// provided row does not have all columns of the partition key
- /// set.
+ /// @return Status::OK if successful. May return a bad Status if the
+ /// provided row does not have all columns of the partition key
+ /// set.
Status PartitionRow(const KuduPartialRow& row, int* partition);
private:
class KUDU_NO_EXPORT Data;