Go to the documentation of this file.
16 #ifndef GRAPHSCOPE_FRAGMENT_SCHEMA_H_
17 #define GRAPHSCOPE_FRAGMENT_SCHEMA_H_
19 #include "flex/engines/hqps_db/core/utils/hqps_utils.h"
63 "shortest_path_among_three";
86 const std::string& label,
const std::vector<PropertyType>& property_types,
87 const std::vector<std::string>& property_names,
88 const std::vector<std::tuple<PropertyType, std::string, size_t>>&
90 const std::vector<StorageStrategy>& strategies = {},
91 size_t max_vnum =
static_cast<size_t>(1) << 32,
92 const std::string& description =
"");
95 const std::string& dst_label,
96 const std::string& edge_label,
97 const std::vector<PropertyType>& properties,
98 const std::vector<std::string>& prop_names,
101 bool oe_mutable =
true,
bool ie_mutable =
true,
102 bool sort_on_compaction =
false,
103 const std::string& description =
"");
114 label_t label_id,
const std::vector<PropertyType>& types,
115 const std::vector<StorageStrategy>& strategies = {});
118 const std::string& label)
const;
121 const std::string& label)
const;
133 const std::string& label)
const;
137 bool exist(
const std::string& src_label,
const std::string& dst_label,
138 const std::string& edge_label)
const;
144 const std::string& src_label,
const std::string& dst_label,
145 const std::string& label)
const;
156 const std::string& dst_label,
157 const std::string& label)
const;
165 const std::string& src_label,
const std::string& dst_label,
166 const std::string& label)
const;
173 const std::string& prop)
const;
176 const std::string& prop)
const;
179 const std::string& dst_label,
180 const std::string& edge_label,
181 const std::string& prop)
const;
186 const std::string& dst_label,
187 const std::string& edge_label)
const;
193 const std::string& dst_label,
194 const std::string& label)
const;
197 const std::string& dst_label,
198 const std::string& label)
const;
201 const std::string& dst_label,
202 const std::string& label)
const;
219 const std::string& dst_label,
220 const std::string& label)
const;
223 const std::string& dst_label,
224 const std::string& label)
const;
227 const std::string& dst_label,
228 const std::string& label)
const;
238 const std::vector<std::tuple<PropertyType, std::string, size_t>>&
243 void Serialize(std::unique_ptr<grape::LocalIOAdaptor>& writer)
const;
245 void Deserialize(std::unique_ptr<grape::LocalIOAdaptor>& reader);
254 const std::unordered_map<std::string, std::pair<std::string, uint8_t>>&
258 const std::vector<std::pair<std::string, std::string>>& plugins);
276 const std::unordered_map<std::string, std::pair<PropertyType, uint8_t>>&
291 std::vector<std::vector<std::tuple<PropertyType, std::string, size_t>>>
303 std::vector<std::unordered_map<std::string, std::pair<PropertyType, uint8_t>>>
306 std::unordered_map<std::string, std::pair<std::string, uint8_t>>
318 #endif // GRAPHSCOPE_FRAGMENT_SCHEMA_H_
std::map< uint32_t, bool > oe_mutability_
Definition: schema.h:300
void add_vertex_label(const std::string &label, const std::vector< PropertyType > &property_types, const std::vector< std::string > &property_names, const std::vector< std::tuple< PropertyType, std::string, size_t >> &primary_key, const std::vector< StorageStrategy > &strategies={}, size_t max_vnum=static_cast< size_t >(1)<< 32, const std::string &description="")
Definition: schema.cc:61
static constexpr uint8_t BUILTIN_PLUGIN_NUM
Definition: schema.h:51
bool get_sort_on_compaction(const std::string &src_label, const std::string &dst_label, const std::string &label) const
Definition: schema.cc:347
std::string version_
Definition: schema.h:311
bool has_edge_label(const std::string &src_label, const std::string &dst_label, const std::string &edge_label) const
Definition: schema.cc:1445
static constexpr const char * MAX_LENGTH_KEY
Definition: schema.h:48
label_t get_edge_label_id(const std::string &label) const
Definition: schema.cc:362
std::map< uint32_t, bool > ie_mutability_
Definition: schema.h:301
bool outgoing_edge_mutable(const std::string &src_label, const std::string &dst_label, const std::string &label) const
Definition: schema.cc:327
std::map< uint32_t, std::string > e_descriptions_
Definition: schema.h:297
static constexpr const char * HQPS_ADHOC_READ_PLUGIN_ID_STR
Definition: schema.h:42
static Result< Schema > LoadFromYaml(const std::string &schema_config)
Definition: schema.cc:1468
static constexpr uint8_t ADHOC_READ_PLUGIN_ID
Definition: schema.h:35
EdgeStrategy get_outgoing_edge_strategy(const std::string &src_label, const std::string &dst_label, const std::string &label) const
Definition: schema.cc:307
label_t vertex_label_to_index(const std::string &label)
Definition: schema.cc:447
static constexpr const char * VARCHAR_KEY
Definition: schema.h:47
static constexpr uint8_t BUILTIN_COUNT_VERTICES_PLUGIN_ID
Definition: schema.h:53
static constexpr uint8_t BUILTIN_TVSP_PLUGIN_ID
Definition: schema.h:61
PropertyType get_edge_property(label_t src, label_t dst, label_t edge) const
Definition: schema.cc:267
EdgeStrategy get_incoming_edge_strategy(const std::string &src_label, const std::string &dst_label, const std::string &label) const
Definition: schema.cc:317
void Deserialize(std::unique_ptr< grape::LocalIOAdaptor > &reader)
Definition: schema.cc:421
static constexpr const char * PRIMITIVE_TYPE_KEY
Definition: schema.h:46
std::string description_
Definition: schema.h:310
IdIndexer< std::string, label_t > vlabel_indexer_
Definition: schema.h:286
Definition: adj_list.h:23
bool EmplacePlugins(const std::vector< std::pair< std::string, std::string >> &plugins)
Definition: schema.cc:1264
std::string get_edge_description(const std::string &src_label, const std::string &dst_label, const std::string &label) const
Definition: schema.cc:240
static Result< Schema > LoadFromYamlNode(const YAML::Node &schema_node)
Definition: schema.cc:1483
EdgeStrategy get_outgoing_edge_strategy(label_t src_label, label_t dst_label, label_t label) const
Definition: schema.h:204
static const std::vector< std::string > COMPATIBLE_VERSIONS
Definition: schema.h:72
void Serialize(std::unique_ptr< grape::LocalIOAdaptor > &writer) const
Definition: schema.cc:409
const std::vector< StorageStrategy > & get_vertex_storage_strategies(const std::string &label) const
Definition: schema.cc:180
std::string compiler_path_
Definition: schema.h:312
void set_compiler_path(const std::string &compiler_path)
Definition: schema.cc:35
std::map< uint32_t, EdgeStrategy > oe_strategy_
Definition: schema.h:298
const std::string & get_compiler_path() const
Definition: schema.cc:39
bool vertex_has_primary_key(const std::string &label, const std::string &prop) const
Definition: schema.cc:1407
static constexpr uint8_t RESERVED_PLUGIN_NUM
Definition: schema.h:33
const std::string & get_vertex_primary_key_name(label_t index) const
Definition: schema.cc:398
const std::vector< std::string > & get_edge_property_names(const std::string &src_label, const std::string &dst_label, const std::string &label) const
Definition: schema.cc:273
const std::vector< PropertyType > & get_edge_properties(const std::string &src_label, const std::string &dst_label, const std::string &label) const
Definition: schema.cc:216
Schema()
Definition: schema.cc:32
std::string GetDescription() const
Definition: schema.cc:1384
std::vector< size_t > max_vnum_
Definition: schema.h:305
void RemovePlugin(const std::string &plugin_name)
Definition: schema.cc:1378
static constexpr const char * BUILTIN_TVSP_PLUGIN_NAME
Definition: schema.h:62
static constexpr const char * BUILTIN_COUNT_VERTICES_PLUGIN_NAME
Definition: schema.h:54
bool valid_edge_property(const std::string &src_label, const std::string &dst_label, const std::string &label) const
Definition: schema.cc:297
void SetPluginDir(const std::string &plugin_dir)
Definition: schema.cc:1376
std::unordered_map< std::string, std::pair< std::string, uint8_t > > plugin_name_to_path_and_id_
Definition: schema.h:307
label_t vertex_label_num() const
Definition: schema.cc:110
static constexpr uint8_t BUILTIN_PLUGIN_IDS[BUILTIN_PLUGIN_NUM]
Definition: schema.h:67
std::string GetPluginDir() const
Definition: schema.cc:1382
static constexpr uint8_t CYPHER_READ_PLUGIN_ID
Definition: schema.h:39
label_t edge_label_num() const
Definition: schema.cc:114
static constexpr uint8_t BUILTIN_PAGERANK_PLUGIN_ID
Definition: schema.h:56
void SetVersion(const std::string &version)
Definition: schema.cc:1390
std::map< uint32_t, std::vector< std::string > > eprop_names_
Definition: schema.h:296
void set_vertex_properties(label_t label_id, const std::vector< PropertyType > &types, const std::vector< StorageStrategy > &strategies={})
Definition: schema.cc:130
std::string get_vertex_label_name(label_t index) const
Definition: schema.cc:374
void SetDescription(const std::string &description)
Definition: schema.cc:1386
std::string GetVersion() const
Definition: schema.cc:1391
std::map< uint32_t, EdgeStrategy > ie_strategy_
Definition: schema.h:299
bool has_vertex_label(const std::string &label) const
Definition: schema.cc:1440
bool has_multi_props_edge_
Definition: schema.h:313
static constexpr uint8_t BUILTIN_K_DEGREE_NEIGHBORS_PLUGIN_ID
Definition: schema.h:58
std::map< uint32_t, std::vector< PropertyType > > eproperties_
Definition: schema.h:295
static constexpr const char * BUILTIN_PAGERANK_PLUGIN_NAME
Definition: schema.h:57
void Clear()
Definition: schema.cc:41
const std::string & get_vertex_description(const std::string &label) const
Definition: schema.cc:165
static constexpr uint8_t MAX_PLUGIN_ID
Definition: schema.h:34
label_t label_type
Definition: schema.h:77
bool Equals(const Schema &other) const
Definition: schema.cc:479
static constexpr uint8_t HQPS_ADHOC_WRITE_PLUGIN_ID
Definition: schema.h:37
std::string plugin_dir_
Definition: schema.h:309
static constexpr const char * CYPHER_READ_DEBUG_PLUGIN_ID_STR
Definition: schema.h:45
static constexpr uint8_t CYPHER_WRITE_PLUGIN_ID
Definition: schema.h:40
const std::vector< std::string > & get_vertex_property_names(const std::string &label) const
Definition: schema.cc:149
std::map< uint32_t, bool > sort_on_compactions_
Definition: schema.h:302
const std::unordered_map< std::string, std::pair< std::string, uint8_t > > & GetPlugins() const
Definition: schema.cc:1258
EdgeStrategy
Definition: types.h:24
const std::vector< PropertyType > & get_vertex_properties(const std::string &label) const
Definition: schema.cc:138
static constexpr const char * BUILTIN_PLUGIN_NAMES[BUILTIN_PLUGIN_NUM]
Definition: schema.h:64
std::vector< std::unordered_map< std::string, std::pair< PropertyType, uint8_t > > > vprop_name_to_type_and_index_
Definition: schema.h:304
static constexpr const char * BUILTIN_K_DEGREE_NEIGHBORS_PLUGIN_NAME
Definition: schema.h:59
static constexpr uint8_t CYPHER_READ_DEBUG_PLUGIN_ID
Definition: schema.h:41
static constexpr const char * ADHOC_READ_PLUGIN_ID_STR
Definition: schema.h:44
bool vertex_has_property(const std::string &label, const std::string &prop) const
Definition: schema.cc:1396
std::string get_edge_label_name(label_t index) const
Definition: schema.cc:382
bool contains_vertex_label(const std::string &label) const
Definition: schema.cc:118
void add_edge_label(const std::string &src_label, const std::string &dst_label, const std::string &edge_label, const std::vector< PropertyType > &properties, const std::vector< std::string > &prop_names, EdgeStrategy oe=EdgeStrategy::kMultiple, EdgeStrategy ie=EdgeStrategy::kMultiple, bool oe_mutable=true, bool ie_mutable=true, bool sort_on_compaction=false, const std::string &description="")
Definition: schema.cc:83
uint32_t generate_edge_label(label_t src, label_t dst, label_t edge) const
Definition: schema.cc:468
size_t get_max_vnum(const std::string &label) const
Definition: schema.cc:191
std::vector< std::vector< PropertyType > > vproperties_
Definition: schema.h:288
bool exist(const std::string &src_label, const std::string &dst_label, const std::string &edge_label) const
Definition: schema.cc:201
bool contains_edge_label(const std::string &label) const
Definition: schema.cc:369
static constexpr const char * DEFAULT_SCHEMA_VERSION
Definition: schema.h:73
static const std::vector< std::string > & GetCompatibleVersions()
Definition: schema.cc:1494
uint8_t label_t
Definition: types.h:32
static bool IsBuiltinPlugin(const std::string &plugin_name)
Definition: schema.cc:23
bool incoming_edge_mutable(const std::string &src_label, const std::string &dst_label, const std::string &label) const
Definition: schema.cc:337
std::vector< std::vector< std::string > > vprop_names_
Definition: schema.h:289
EdgeStrategy get_incoming_edge_strategy(label_t src_label, label_t dst_label, label_t label) const
Definition: schema.h:211
static constexpr const char * HQPS_ADHOC_WRITE_PLUGIN_ID_STR
Definition: schema.h:43
IdIndexer< std::string, label_t > elabel_indexer_
Definition: schema.h:287
label_t edge_label_to_index(const std::string &label)
Definition: schema.cc:462
std::vector< std::vector< StorageStrategy > > vprop_storage_
Definition: schema.h:294
label_t get_vertex_label_id(const std::string &label) const
Definition: schema.cc:123
bool has_multi_props_edge() const
Definition: schema.cc:1393
std::vector< std::string > v_descriptions_
Definition: schema.h:290
const std::vector< std::tuple< PropertyType, std::string, size_t > > & get_vertex_primary_key(label_t index) const
Definition: schema.cc:391
const std::unordered_map< std::string, std::pair< PropertyType, uint8_t > > & get_vprop_name_to_type_and_index(label_t label) const
Definition: schema.cc:197
std::vector< std::vector< std::tuple< PropertyType, std::string, size_t > > > v_primary_keys_
Definition: schema.h:292
static constexpr uint8_t HQPS_ADHOC_READ_PLUGIN_ID
Definition: schema.h:36
bool edge_has_property(const std::string &src_label, const std::string &dst_label, const std::string &edge_label, const std::string &prop) const
Definition: schema.cc:1421