1 /**
2 * @file group.h
3 *
4 * @author Ravi Gaddipati
5 *
6 * @section LICENSE
7 *
8 * The MIT License
9 *
10 * @copyright Copyright (c) 2017-2021 TileDB, Inc.
11 *
12 * Permission is hereby granted, free of charge, to any person obtaining a copy
13 * of this software and associated documentation files (the "Software"), to deal
14 * in the Software without restriction, including without limitation the rights
15 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16 * copies of the Software, and to permit persons to whom the Software is
17 * furnished to do so, subject to the following conditions:
18 *
19 * The above copyright notice and this permission notice shall be included in
20 * all copies or substantial portions of the Software.
21 *
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
28 * THE SOFTWARE.
29 *
30 * @section DESCRIPTION
31 *
32 * This file declares the C++ API for the TileDB groups.
33 */
34
35 #ifndef TILEDB_CPP_API_GROUP_H
36 #define TILEDB_CPP_API_GROUP_H
37
38 #include "context.h"
39 #include "tiledb.h"
40
41 namespace tiledb {
42
43 /**
44 * Creates a new group. A Group is a logical grouping of Objects on the
45 * storage system (a directory).
46 *
47 * @param ctx The TileDB context.
48 * @param group The group URI.
49 * @return void
50 */
create_group(const Context & ctx,const std::string & group)51 inline void create_group(const Context& ctx, const std::string& group) {
52 ctx.handle_error(tiledb_group_create(ctx.ptr().get(), group.c_str()));
53 }
54
55 } // namespace tiledb
56
57 #endif // TILEDB_CPP_API_GROUP_H
58