ORE Studio 0.0.4
Loading...
Searching...
No Matches
artefact_type.hpp
1/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 *
3 * Copyright (C) 2025 Marco Craveiro <marco.craveiro@gmail.com>
4 *
5 * This program is free software; you can redistribute it and/or modify it under
6 * the terms of the GNU General Public License as published by the Free Software
7 * Foundation; either version 3 of the License, or (at your option) any later
8 * version.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
13 * details.
14 *
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 *
19 */
20#ifndef ORES_DQ_API_DOMAIN_ARTEFACT_TYPE_HPP
21#define ORES_DQ_API_DOMAIN_ARTEFACT_TYPE_HPP
22
23#include <string>
24#include <optional>
25
26namespace ores::dq::domain {
27
39struct artefact_type final {
43 std::string tenant_id;
44
51 std::string code;
52
56 std::string name;
57
61 std::optional<std::string> description;
62
69 std::optional<std::string> artefact_table;
70
77 std::optional<std::string> target_table;
78
86 std::optional<std::string> populate_function;
87
92};
93
94}
95
96#endif
Maps artefact type codes to their population functions and tables.
Definition artefact_type.hpp:39
int display_order
Display order for UI sorting.
Definition artefact_type.hpp:91
std::optional< std::string > populate_function
Name of the database function that populates the target table.
Definition artefact_type.hpp:86
std::string code
Unique code identifying this artefact type.
Definition artefact_type.hpp:51
std::optional< std::string > artefact_table
Name of the artefact (staging) table for this type.
Definition artefact_type.hpp:69
std::optional< std::string > description
Detailed description of this artefact type.
Definition artefact_type.hpp:61
std::string name
Human-readable name for display purposes.
Definition artefact_type.hpp:56
std::string tenant_id
Tenant identifier for multi-tenancy isolation.
Definition artefact_type.hpp:43
std::optional< std::string > target_table
Name of the target (production) table for this type.
Definition artefact_type.hpp:77