201701.mbox/raw/%3c5f01cb16347e4f8aaad4937e39b6ec06@git.apache.org%3e

 //

- // 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.

- #ifndef KUDU_CLIENT_SCHEMA_H

- #define KUDU_CLIENT_SCHEMA_H

-

- #include <string>

- #include <vector>

-

- #include "kudu/client/value.h"

- #include "kudu/util/kudu_export.h"

-

- namespace kudu {

-

- class ColumnSchema;

- class KuduPartialRow;

- class Schema;

- class TestWorkload;

-

- namespace tools {

- class RemoteKsckMaster;

- class ReplicaDumper;

- }

-

- namespace client {

-

- namespace internal {

- class GetTableSchemaRpc;

- class LookupRpc;

- class MetaCacheEntry;

- class WriteRpc;

- } // namespace internal

-

- class KuduClient;

- class KuduSchema;

- class KuduSchemaBuilder;

- class KuduWriteOperation;

-

- class KUDU_EXPORT KuduColumnStorageAttributes {

-  public:

-   enum EncodingType {

-     AUTO_ENCODING = 0,

-     PLAIN_ENCODING = 1,

-     PREFIX_ENCODING = 2,

-     GROUP_VARINT = 3,

-     RLE = 4,

-     DICT_ENCODING = 5,

-     BIT_SHUFFLE = 6

-   };

-

-   enum CompressionType {

-     DEFAULT_COMPRESSION = 0,

-     NO_COMPRESSION = 1,

-     SNAPPY = 2,

-     LZ4 = 3,

-     ZLIB = 4,

-   };

-

-

-   explicit KuduColumnStorageAttributes(

-       EncodingType encoding = AUTO_ENCODING,

-       CompressionType compression = DEFAULT_COMPRESSION,

-       int32_t block_size = 0)

-       ATTRIBUTE_DEPRECATED("this constructor will be private in a future release")

-       : encoding_(encoding),

-         compression_(compression),

-         block_size_(block_size) {

-   }

-

-   const EncodingType encoding() const {

-     return encoding_;

-   }

-

-   const CompressionType compression() const {

-     return compression_;

-   }

-

-   std::string ToString() const;

-

-  private:

-   EncodingType encoding_;

-   CompressionType compression_;

-   int32_t block_size_;

- };

-

- class KUDU_EXPORT KuduColumnSchema {

-  public:

-   enum DataType {

-     INT8 = 0,

-     INT16 = 1,

-     INT32 = 2,

-     INT64 = 3,

-     STRING = 4,

-     BOOL = 5,

-     FLOAT = 6,

-     DOUBLE = 7,

-     BINARY = 8,

-     UNIXTIME_MICROS = 9,

-     TIMESTAMP = UNIXTIME_MICROS

-   };

-

-   static std::string DataTypeToString(DataType type);

-

-   KuduColumnSchema(const std::string &name,

-                    DataType type,

-                    bool is_nullable = false,

-                    const void* default_value = NULL,

-                    KuduColumnStorageAttributes attributes = KuduColumnStorageAttributes())

-       ATTRIBUTE_DEPRECATED("use KuduSchemaBuilder instead");

-

-   KuduColumnSchema(const KuduColumnSchema& other);

-   ~KuduColumnSchema();

-

-   KuduColumnSchema& operator=(const KuduColumnSchema& other);

-

-   void CopyFrom(const KuduColumnSchema& other);

-

-   bool Equals(const KuduColumnSchema& other) const;

-

-   const std::string& name() const;

-

-   DataType type() const;

-

-   bool is_nullable() const;

-

-  private:

-   friend class KuduColumnSpec;

-   friend class KuduSchema;

-   friend class KuduSchemaBuilder;

-   // KuduTableAlterer::Data needs to be a friend. Friending the parent class

-   // is transitive to nested classes. See http://tiny.cloudera.com/jwtui

-   friend class KuduTableAlterer;

-

-   KuduColumnSchema();

-

-   // Owned.

-   ColumnSchema* col_;

- };

-

- class KUDU_EXPORT KuduColumnSpec {

-  public:

-   KuduColumnSpec* Default(KuduValue* value);

-

-   KuduColumnSpec* Compression(KuduColumnStorageAttributes::CompressionType compression);

-

-   KuduColumnSpec* Encoding(KuduColumnStorageAttributes::EncodingType encoding);

-

-   KuduColumnSpec* BlockSize(int32_t block_size);

-

-   KuduColumnSpec* PrimaryKey();

-

-   KuduColumnSpec* NotNull();

-

-   KuduColumnSpec* Nullable();

-

-   KuduColumnSpec* Type(KuduColumnSchema::DataType type);

-

-   KuduColumnSpec* RemoveDefault();

-

-   KuduColumnSpec* RenameTo(const std::string& new_name);

-

-  private:

-   class KUDU_NO_EXPORT Data;

-   friend class KuduSchemaBuilder;

-   friend class KuduTableAlterer;

-

-   // This class should always be owned and deleted by one of its friends,

-   // not the user.

-   ~KuduColumnSpec();

-

-   explicit KuduColumnSpec(const std::string& col_name);

-

-   Status ToColumnSchema(KuduColumnSchema* col) const;

-

-   // Owned.

-   Data* data_;

- };

-

- class KUDU_EXPORT KuduSchemaBuilder {

-  public:

-   KuduSchemaBuilder();

-   ~KuduSchemaBuilder();

-

-   KuduColumnSpec* AddColumn(const std::string& name);

-

-   KuduSchemaBuilder* SetPrimaryKey(const std::vector<std::string>& key_col_names);

-

-   Status Build(KuduSchema* schema);

-

-  private:

-   class KUDU_NO_EXPORT Data;

-   // Owned.

-   Data* data_;

- };

-

- class KUDU_EXPORT KuduSchema {

-  public:

-   KuduSchema();

-

-   KuduSchema(const KuduSchema& other);

-   ~KuduSchema();

-

-   KuduSchema& operator=(const KuduSchema& other);

-   void CopyFrom(const KuduSchema& other);

-

-   Status Reset(const std::vector<KuduColumnSchema>& columns, int key_columns)

-       ATTRIBUTE_DEPRECATED("this method will be removed in a future release")

-       WARN_UNUSED_RESULT;

-

-   bool Equals(const KuduSchema& other) const;

-

-   KuduColumnSchema Column(size_t idx) const;

-

-   size_t num_columns() const;

-

-   void GetPrimaryKeyColumnIndexes(std::vector<int>* indexes) const;

-

-   KuduPartialRow* NewRow() const;

-

-  private:

-   friend class KuduClient;

-   friend class KuduScanner;

-   friend class KuduScanToken;

-   friend class KuduScanTokenBuilder;

-   friend class KuduSchemaBuilder;

-   friend class KuduTable;

-   friend class KuduTableCreator;

-   friend class KuduWriteOperation;

-   friend class ScanConfiguration;

-   friend class internal::GetTableSchemaRpc;

-   friend class internal::LookupRpc;

-   friend class internal::MetaCacheEntry;

-   friend class internal::WriteRpc;

-   friend class tools::RemoteKsckMaster;

-   friend class tools::ReplicaDumper;

-

-   friend KuduSchema KuduSchemaFromSchema(const Schema& schema);

-

-

-   // For use by kudu tests.

-   explicit KuduSchema(const Schema& schema);

-

-   // Private since we don't want users to rely on the first N columns

-   // being the keys.

-   size_t num_key_columns() const;

-

-   // Owned.

-   Schema* schema_;

- };

-

- } // namespace client

- } // namespace kudu

- #endif // KUDU_CLIENT_SCHEMA_H

-kudu::client::KuduSchema
A representation of a table's schema.
Definition: schema.h:414

-kudu::Status
A representation of an operation's outcome.
Definition: status.h:116

+ //
 // 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.
 #ifndef KUDU_CLIENT_SCHEMA_H
 #define KUDU_CLIENT_SCHEMA_H

 #include <string>
 #include <vector>

 #include "kudu/client/value.h"
 #include "kudu/util/kudu_export.h"

 namespace kudu {

 class ColumnSchema;
 class KuduPartialRow;
 class Schema;
 class TestWorkload;

 namespace tools {
<
 span class="lineno">   35 class RemoteKsckMaster;
 class ReplicaDumper;
 }

 namespace client {

 namespace internal {
 class GetTableSchemaRpc;
 class L
 ookupRpc;
 class MetaCacheEntry;
 class WriteRpc;
 } // namespace internal

 class KuduClient;
 class KuduSchema;
 class KuduSchemaBuilder;
 cla
 ss KuduWriteOperation;

 class KUDU_EXPORT KuduColumnStorageAttributes {
  public:
   enum EncodingType {
     AUTO_ENCODING = 0,
     PLAIN_ENCODING = 1,
     PREFIX_ENCODING = 2,
     RLE = 4,
     DICT_ENCODING = 5,
     BIT_SHUFFLE = 6,

     GROUP_VARINT = 3
   };

   enum CompressionType {
     DEFAULT_COMPRESSION = 0,
     NO_COMPRESSION = 1,
     SNAPPY = 2,
     LZ4 = 3,
     ZLIB = 4,
   };


   explicit KuduColumnStorageAttributes(
       EncodingType encoding = AUTO_ENCODING,
       CompressionType compression = DEFAULT_COMPRESSION,
       int32_t block_size = 0)
       ATTRIBUTE_DEPRECATED("this constructor will be private in a future release")
       : encoding_(encoding),
         compression_(compression),
         block_size_(block_size) {
   }

   const EncodingType encoding() const {
     return encoding_;
   }

   const CompressionType compression() const {
     return compression_;
   }

   std::string ToString() const;

  private:
   EncodingType encoding_;
   CompressionType compression_;
   int32_t block_size_;
 };

 class KUDU_EXPORT KuduColumnSchema {
  public:
   enum DataType {
     INT8 = 0,
     INT16 = 1,
     INT32 = 2,
     INT64 = 3,
     STRING = 4,
  130     BOOL = 5,
     FLOAT = 6,
     DOUBLE = 7,
     BINARY = 8,
     UNIXTIME_MICROS = 9,
     TIMESTAMP = UNIXTIME_MICROS
   };

   static s
 td::string DataTypeToString(DataType type);

   KuduColumnSchema(const std::string &name,
                    DataType type,
                    bool is_nullable = false,
                    const void* default_value = NULL,
                    KuduColumnStorageAttributes attributes = KuduColumnStorageAttributes())
       ATTRIBUTE_DEPRECATED("use KuduSchemaBuilder instead");

   KuduColumnSchema(const KuduColumnSchema& other);
   ~KuduColumnSchema();

   KuduColumnSchema& operator=(const KuduColumnSchema& other);

   void CopyFrom(const KuduColumnSchema& other);

   bool Equals(const KuduColumnSchema& other) const;

   const std::string& name() const;

   DataType type() const;

   bool is_nullable() const;
  private:
   friend class KuduColumnSpec;
   friend class KuduSchema;
   friend class KuduSchemaBuilder;
   // KuduTableAlterer::Data needs to be a friend. Friending the parent class

   // is transitive to nested classes. See http://tiny.cloudera.com/jwtui
   friend class KuduTableAlterer;

   KuduColumnSchema();

   // Owned.
   ColumnSchema* col_;
 };
 class KUDU_EXPORT KuduColumnSpec {
  public:
   KuduColumnSpec* Default(KuduValue* value);

   KuduColumnSpec* Compression(KuduColumnStorageAttributes::CompressionType compression);
    KuduColumnSpec* Encoding(KuduColumnStorageAttributes::EncodingType encoding);

   KuduColumnSpec* BlockSize(int32_t block_size);

   KuduColumnSpec* PrimaryKey();

   KuduColumnSpec* NotNull();


    KuduColumnSpec* Nullable();

   KuduColumnSpec* Type(KuduColumnSchema::DataType type);

   KuduColumnSpec* RemoveDefault();

   KuduColumnSpec* RenameTo(const std::string& new_name);

  private:
   class KUDU_NO_EXPORT Data;
   friend class KuduSchemaBuilder;
   friend class KuduTableAlterer;

   // This class should always be owned and deleted by one of its friends,
   // not the user.
   ~KuduColumnSpec();

   explicit KuduColumnSpec(const std::string& col_name);

   Status ToColumnSchema(KuduColumnSchema* col) const;

   // Owned.

    Data* data_;
 };

 class KUDU_EXPORT KuduSchemaBuilder {
  public:
   KuduSchemaBuilder();
   ~KuduSchemaBuilder(
 );

   KuduColumnSpec* AddColumn(const std::string& name);

   KuduSchemaBuilder* SetPrimaryKey(const std::vector<std::string>& key_col_names);

   Status Build(KuduSchema* schema);

  private:
   class KUDU_NO_EXPORT Data;
   // Owned.
   Data* data_;
 };

 class KUDU_EXPORT KuduSchema {
  public:
   KuduSchema();

   KuduSchema(const KuduSchema& other);
   ~KuduSchema();

  434   KuduSchema& operator=(const KuduSchema& other);
   void CopyFrom(const KuduSchema& other);

   Status Reset(const std::vector<KuduColumnSchema>& columns, int key_columns)
       ATTRIBUTE_DEPRECATED("this method will be removed in a future release")
       WARN_UNUSED_RESULT;

   bool Equals(const KuduSchema& other) const;

   KuduColumnSchema Column(size_t idx) const;

   size_t num_columns() const;

   void GetPrimaryKeyColumnIndexes(std::vector<int>* indexes) const;

   KuduPartialRow* NewRow() const;

  private:
   friend class KuduClient;
   friend class KuduScanner;
   friend class KuduScanToken;
   friend class KuduScanTokenBuilder;
   friend class KuduTable;
   friend class KuduTableCreator;
   friend class KuduWriteOperation;
   friend class ScanConfiguration;
   friend class internal::GetTableSchemaRpc;
   friend class internal::LookupRpc;
   friend class internal::MetaCacheEntry;
   friend class internal::WriteRpc;
   friend class tools::RemoteKsckMaster;
   friend class tools::ReplicaDumper;

   friend KuduSchema KuduSchemaFromSchema(const Schema& schema);


   // For use by kudu tests.
   explicit KuduSchema(const Schema& schema);

   // Private since we don't want users to rely on the first N columns
   // being the keys.
   size_t num_key_columns() const;

   // Owned.
   Schema* schema_;
 };

 } // namespace client
 } // namespace kudu
 #endif // KUDU_CLIENT_SCHEMA_H
kudu::client::KuduSchema
A representation of a table&#39;s schema.
Definition: schema.h:417

+kudu::Status
A representation of an operation&#39;s outcome.
Definition: status.h:116

 kudu::client::KuduValue
A constant cell value with a specific type.
Definition: value.h:33

+kudu
Definition: callbacks.h:28

 kudu::client::KuduColumnStorageAttributes
Representation of column storage attributes.
Definition: schema.h:54

-kudu::client::KuduColumnSpec
Builder API for specifying or altering a column within a table schema.
Definition: schema.h:227

-kudu::client::KuduColumnSchema
Representation of the column schema.
Definition: schema.h:118

-kudu::client::KuduColumnStorageAttributes::encoding
const EncodingType encoding() const
Definition: schema.h:99

-kudu::client::KuduScanTokenBuilder
Builds scan tokens for a table.
Definition: client.h:1978

-kudu::client::KuduTableAlterer
Alters an existing table based on the provided steps.
Definition: client.h:918

-kudu::client::KuduColumnStorageAttributes::KuduColumnStorageAttributes
KuduColumnStorageAttributes(EncodingType encoding=AUTO_ENCODING, CompressionType compression=DEFAULT_COMPRESSION, int32_t block_size=0) ATTRIBUTE_DEPRECATED("this const ructor will be private in a future release"