Flex  0.17.9
graph_db.h
Go to the documentation of this file.
1 
16 #ifndef GRAPHSCOPE_DATABASE_GRAPH_DB_H_
17 #define GRAPHSCOPE_DATABASE_GRAPH_DB_H_
18 
19 #include <dlfcn.h>
20 
21 #include <map>
22 #include <mutex>
23 #include <thread>
24 #include <vector>
25 
36 
37 namespace gs {
38 
39 class GraphDB;
40 class GraphDBSession;
41 struct SessionLocalContext;
42 
43 struct GraphDBConfig {
44  GraphDBConfig(const Schema& schema_, const std::string& data_dir_,
45  int thread_num_ = 1)
46  : schema(schema_),
47  data_dir(data_dir_),
48  thread_num(thread_num_),
49  warmup(false),
50  enable_monitoring(false),
52  memory_level(1) {}
53 
55  std::string data_dir;
57  bool warmup;
60 
61  /*
62  0 - sync with disk;
63  1 - mmap virtual memory;
64  2 - preferring hugepages;
65  3 - force hugepages;
66  */
68 };
69 
70 class GraphDB {
71  public:
72  GraphDB();
73  ~GraphDB();
74 
75  static GraphDB& get();
76 
85  Result<bool> Open(const Schema& schema, const std::string& data_dir,
86  int32_t thread_num = 1, bool warmup = false,
87  bool memory_only = true,
88  bool enable_auto_compaction = false);
89 
90  Result<bool> Open(const GraphDBConfig& config);
91 
95  void Close();
96 
102 
108  InsertTransaction GetInsertTransaction(int thread_id = 0);
109 
116  int thread_id = 0);
117 
124 
130  UpdateTransaction GetUpdateTransaction(int thread_id = 0);
131 
132  const MutablePropertyFragment& graph() const;
134 
135  const Schema& schema() const;
136 
137  std::shared_ptr<ColumnBase> get_vertex_property_column(
138  uint8_t label, const std::string& col_name) const;
139 
140  AppWrapper CreateApp(uint8_t app_type, int thread_id);
141 
142  void GetAppInfo(Encoder& result);
143 
144  GraphDBSession& GetSession(int thread_id);
145  const GraphDBSession& GetSession(int thread_id) const;
146 
147  int SessionNum() const;
148 
151 
152  private:
153  bool registerApp(const std::string& path, uint8_t index = 0);
154 
155  void ingestWals(const std::vector<std::string>& wals,
156  const std::string& work_dir, int thread_num);
157 
158  void initApps(
159  const std::unordered_map<std::string, std::pair<std::string, uint8_t>>&
160  plugins);
161 
162  void openWalAndCreateContexts(const std::string& data_dir_path,
163  MemoryStrategy allocator_strategy);
164 
165  void showAppMetrics() const;
166 
167  size_t getExecutedQueryNum() const;
168 
169  friend class GraphDBSession;
170 
171  std::string work_dir_;
173 
175 
178 
179  std::array<std::string, 256> app_paths_;
180  std::array<std::shared_ptr<AppFactoryBase>, 256> app_factories_;
181 
182  std::thread monitor_thread_;
184 
187  std::thread compact_thread_;
188 };
189 
190 } // namespace gs
191 
192 #endif // GRAPHSCOPE_DATABASE_GRAPH_DB_H_
gs::MemoryStrategy
MemoryStrategy
Definition: mmap_array.h:58
gs::Result
Definition: result.h:62
gs::GraphDB::GetReadTransaction
ReadTransaction GetReadTransaction()
Create a transaction to read vertices and edges.
Definition: graph_db.cc:259
gs::GraphDB::contexts_
SessionLocalContext * contexts_
Definition: graph_db.h:172
single_vertex_insert_transaction.h
gs::timestamp_t
uint32_t timestamp_t
Definition: types.h:30
gs::GraphDB::graph
const MutablePropertyFragment & graph() const
Definition: graph_db.cc:299
gs::GraphDB::monitor_thread_running_
bool monitor_thread_running_
Definition: graph_db.h:183
gs::GraphDBConfig::thread_num
int thread_num
Definition: graph_db.h:56
gs::GraphDB::get
static GraphDB & get()
Definition: graph_db.cc:63
gs::GraphDB::GetSession
GraphDBSession & GetSession(int thread_id)
Definition: graph_db.cc:282
gs::GraphDB::showAppMetrics
void showAppMetrics() const
Definition: graph_db.cc:459
gs::InsertTransaction
Definition: insert_transaction.h:32
gs::GraphDB::thread_num_
int thread_num_
Definition: graph_db.h:174
gs::GraphDB::CreateApp
AppWrapper CreateApp(uint8_t app_type, int thread_id)
Definition: graph_db.cc:309
gs
Definition: adj_list.h:23
single_edge_insert_transaction.h
gs::GraphDB::monitor_thread_
std::thread monitor_thread_
Definition: graph_db.h:182
gs::GraphDB::GetUpdateTransaction
UpdateTransaction GetUpdateTransaction(int thread_id=0)
Create a transaction to update vertices and edges.
Definition: graph_db.cc:278
insert_transaction.h
gs::GraphDB::SessionNum
int SessionNum() const
Definition: graph_db.cc:290
gs::GraphDB::schema
const Schema & schema() const
Definition: graph_db.cc:302
gs::GraphDB::version_manager_
VersionManager version_manager_
Definition: graph_db.h:177
gs::SessionLocalContext
Definition: graph_db.cc:29
gs::GraphDB::registerApp
bool registerApp(const std::string &path, uint8_t index=0)
Definition: graph_db.cc:319
gs::GraphDB::Open
Result< bool > Open(const Schema &schema, const std::string &data_dir, int32_t thread_num=1, bool warmup=false, bool memory_only=true, bool enable_auto_compaction=false)
Load the graph from data directory.
Definition: graph_db.cc:68
gs::GraphDBConfig::GraphDBConfig
GraphDBConfig(const Schema &schema_, const std::string &data_dir_, int thread_num_=1)
Definition: graph_db.h:44
gs::Encoder
Definition: app_utils.h:25
gs::GraphDBConfig::enable_monitoring
bool enable_monitoring
Definition: graph_db.h:58
gs::SingleEdgeInsertTransaction
Definition: single_edge_insert_transaction.h:30
mutable_property_fragment.h
gs::GraphDB::GetAppInfo
void GetAppInfo(Encoder &result)
Definition: graph_db.cc:335
gs::MutablePropertyFragment
Definition: mutable_property_fragment.h:37
gs::GraphDB::graph_
MutablePropertyFragment graph_
Definition: graph_db.h:176
gs::GraphDB::GetSingleVertexInsertTransaction
SingleVertexInsertTransaction GetSingleVertexInsertTransaction(int thread_id=0)
Create a transaction to insert a single vertex.
Definition: graph_db.cc:268
gs::GraphDBConfig::warmup
bool warmup
Definition: graph_db.h:57
update_transaction.h
gs::GraphDB::get_vertex_property_column
std::shared_ptr< ColumnBase > get_vertex_property_column(uint8_t label, const std::string &col_name) const
Definition: graph_db.cc:304
gs::GraphDB::openWalAndCreateContexts
void openWalAndCreateContexts(const std::string &data_dir_path, MemoryStrategy allocator_strategy)
Definition: graph_db.cc:430
gs::GraphDB::app_factories_
std::array< std::shared_ptr< AppFactoryBase >, 256 > app_factories_
Definition: graph_db.h:180
gs::Schema
Definition: schema.h:29
loading_config.h
gs::GraphDBConfig::enable_auto_compaction
bool enable_auto_compaction
Definition: graph_db.h:59
gs::GraphDBSession
Definition: graph_db_session.h:36
gs::GraphDB
Definition: graph_db.h:70
loader_factory.h
gs::GraphDB::ingestWals
void ingestWals(const std::vector< std::string > &wals, const std::string &work_dir, int thread_num)
Definition: graph_db.cc:374
gs::VersionManager
Definition: version_manager.h:34
gs::GraphDB::getExecutedQueryNum
size_t getExecutedQueryNum() const
Definition: graph_db.cc:478
gs::GraphDB::compact_thread_
std::thread compact_thread_
Definition: graph_db.h:187
gs::GraphDB::GraphDB
GraphDB()
gs::GraphDBConfig::memory_level
int memory_level
Definition: graph_db.h:67
gs::ReadTransaction
Definition: read_transaction.h:277
gs::SingleVertexInsertTransaction
Definition: single_vertex_insert_transaction.h:30
gs::GraphDBConfig::schema
Schema schema
Definition: graph_db.h:54
gs::GraphDBConfig::data_dir
std::string data_dir
Definition: graph_db.h:55
gs::GraphDB::initApps
void initApps(const std::unordered_map< std::string, std::pair< std::string, uint8_t >> &plugins)
Definition: graph_db.cc:399
gs::GraphDB::GetSingleEdgeInsertTransaction
SingleEdgeInsertTransaction GetSingleEdgeInsertTransaction(int thread_id=0)
Create a transaction to insert a single edge.
Definition: graph_db.cc:273
gs::GraphDB::Close
void Close()
Close the current opened graph.
Definition: graph_db.cc:236
gs::GraphDB::compact_thread_running_
bool compact_thread_running_
Definition: graph_db.h:186
version_manager.h
gs::GraphDB::app_paths_
std::array< std::string, 256 > app_paths_
Definition: graph_db.h:179
gs::GraphDB::~GraphDB
~GraphDB()
Definition: graph_db.cc:48
gs::AppWrapper
Definition: app_base.h:78
app_base.h
gs::UpdateTransaction
Definition: update_transaction.h:38
gs::GraphDB::GetInsertTransaction
InsertTransaction GetInsertTransaction(int thread_id=0)
Create a transaction to insert vertices and edges with a default allocator.
Definition: graph_db.cc:264
gs::GraphDB::GetLastCompactionTimestamp
timestamp_t GetLastCompactionTimestamp() const
Definition: graph_db.cc:295
gs::GraphDBConfig
Definition: graph_db.h:43
gs::GraphDB::work_dir_
std::string work_dir_
Definition: graph_db.h:171
gs::GraphDB::last_compaction_ts_
timestamp_t last_compaction_ts_
Definition: graph_db.h:185
read_transaction.h
gs::GraphDB::UpdateCompactionTimestamp
void UpdateCompactionTimestamp(timestamp_t ts)
Definition: graph_db.cc:292