Skip to content

Commit 2651cb7

Browse files
authored
Merge pull request #236 from Open-MBEE/feature/performance_docs
Add snippet about performance
2 parents 0ccf0c6 + be9d25a commit 2651cb7

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/index.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,32 @@ Apply the initialization file
111111

112112
Once the initialization file has been generated at ``cluster.trig``, apply this file to your empty quadstore (for example, by using its Graph Store Protocol API to insert the data) before using Flexo MMS.
113113

114+
Performance Considerations
115+
--------------------------
116+
117+
Writing to a triplestore can impact query performance significantly. For production deployments with moderate to high load, we recommend using a dedicated write node and separate read-only nodes for the triple store.
118+
119+
The service configuration supports this architecture through the following settings:
120+
121+
- ``FLEXO_MMS_UPDATE_URL``: Points to your dedicated write node
122+
- ``FLEXO_MMS_QUERY_URL``: Points to your read-only node(s)
123+
- ``FLEXO_MMS_MASTER_QUERY_URL``: Optional endpoint for when you need the most up-to-date data (typically points to the write node)
124+
125+
With this configuration:
126+
127+
1. All write operations (updates, deletes) will be directed to the dedicated write node
128+
2. Most read operations (queries) will be directed to the read-only node(s)
129+
3. When absolute consistency is required, queries will use the master query URL
130+
131+
This separation provides several benefits:
132+
133+
- Improved query performance by offloading read traffic from the write node
134+
- Better write throughput by dedicating resources to write operations
135+
- Horizontal scalability by adding more read nodes as query demand increases
136+
- Improved reliability as read operations can continue even if the write node is under heavy load
137+
138+
For smaller deployments with limited traffic, a single node configuration may be sufficient, but as your model size and user base grow, the separated architecture becomes increasingly important.
139+
114140
API
115141
---------
116142

0 commit comments

Comments
 (0)