1 /**
2  * @file   array_schema_evolution.h
3  *
4  * @section LICENSE
5  *
6  * The MIT License
7  *
8  * @copyright Copyright (c) 2018-2021 TileDB, Inc.
9  *
10  * Permission is hereby granted, free of charge, to any person obtaining a copy
11  * of this software and associated documentation files (the "Software"), to deal
12  * in the Software without restriction, including without limitation the rights
13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14  * copies of the Software, and to permit persons to whom the Software is
15  * furnished to do so, subject to the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be included in
18  * all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
26  * THE SOFTWARE.
27  *
28  * @section DESCRIPTION
29  *
30  * This file declares serialization functions for ArraySchema.
31  */
32 
33 #ifndef TILEDB_SERIALIZATION_ARRAY_SCHEMA_EVOLUTION_H
34 #define TILEDB_SERIALIZATION_ARRAY_SCHEMA_EVOLUTION_H
35 
36 #include <unordered_map>
37 
38 #include "tiledb/common/status.h"
39 
40 using namespace tiledb::common;
41 
42 namespace tiledb {
43 namespace sm {
44 
45 class Array;
46 class Buffer;
47 class ArraySchema;
48 class ArraySchemaEvolution;
49 class Dimension;
50 enum class SerializationType : uint8_t;
51 
52 namespace serialization {
53 
54 /**
55  * Serialize an array schema evolution via Cap'n Prto
56  * @param array_schema_evolution evolution object to serialize
57  * @param serialize_type format to serialize into Cap'n Proto or JSON
58  * @param serialized_buffer buffer to store serialized bytes in
59  * @param client_side indicate if client or server side. If server side we won't
60  * serialize the array URI
61  * @return
62  */
63 Status array_schema_evolution_serialize(
64     ArraySchemaEvolution* array_schema_evolution,
65     SerializationType serialize_type,
66     Buffer* serialized_buffer,
67     const bool client_side);
68 
69 Status array_schema_evolution_deserialize(
70     ArraySchemaEvolution** array_schema_evolution,
71     SerializationType serialize_type,
72     const Buffer& serialized_buffer);
73 
74 }  // namespace serialization
75 }  // namespace sm
76 }  // namespace tiledb
77 #endif  // TILEDB_SERIALIZATION_ARRAY_SCHEMA_Evolution_H