Skip to content

Commit 64b2af3

Browse files
committed
Regenerated configuration
1 parent 1de6941 commit 64b2af3

File tree

4 files changed

+381
-351
lines changed

4 files changed

+381
-351
lines changed

docs/config.html

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -756,7 +756,26 @@ <h2 id="modelcontextprotocolserver">ModelContextProtocolServer</h2>
756756
<h2
757757
id="postgresqldatabaseconfiguration">PostgreSQLDatabaseConfiguration</h2>
758758
<p>PostgreSQL database configuration.</p>
759+
<p>PostgreSQL database is used by Lightspeed Core Stack service for
760+
storing information about conversation IDs. It can also be leveraged to
761+
store conversation history and information about quota usage.</p>
762+
<p>Useful resources:</p>
763+
<ul>
764+
<li><a
765+
href="https://www.psycopg.org/psycopg3/docs/api/connections.html">Psycopg:
766+
connection classes</a></li>
767+
<li><a href="https://www.connectionstrings.com/postgresql/">PostgreSQL
768+
connection strings</a></li>
769+
<li><a
770+
href="https://www.freecodecamp.org/news/postgresql-in-python/">How to
771+
Use PostgreSQL in Python</a></li>
772+
</ul>
759773
<table>
774+
<colgroup>
775+
<col style="width: 26%" />
776+
<col style="width: 23%" />
777+
<col style="width: 50%" />
778+
</colgroup>
760779
<thead>
761780
<tr class="header">
762781
<th>Field</th>
@@ -768,47 +787,48 @@ <h2 id="modelcontextprotocolserver">ModelContextProtocolServer</h2>
768787
<tr class="odd">
769788
<td>host</td>
770789
<td>string</td>
771-
<td></td>
790+
<td>Database server host or socket directory</td>
772791
</tr>
773792
<tr class="even">
774793
<td>port</td>
775794
<td>integer</td>
776-
<td></td>
795+
<td>Database server port</td>
777796
</tr>
778797
<tr class="odd">
779798
<td>db</td>
780799
<td>string</td>
781-
<td></td>
800+
<td>Database name to connect to</td>
782801
</tr>
783802
<tr class="even">
784803
<td>user</td>
785804
<td>string</td>
786-
<td></td>
805+
<td>Database user name used to authenticate</td>
787806
</tr>
788807
<tr class="odd">
789808
<td>password</td>
790809
<td>string</td>
791-
<td></td>
810+
<td>Password used to authenticate</td>
792811
</tr>
793812
<tr class="even">
794813
<td>namespace</td>
795814
<td></td>
796-
<td></td>
815+
<td>Database namespace</td>
797816
</tr>
798817
<tr class="odd">
799818
<td>ssl_mode</td>
800819
<td>string</td>
801-
<td></td>
820+
<td>SSL mode</td>
802821
</tr>
803822
<tr class="even">
804823
<td>gss_encmode</td>
805824
<td>string</td>
806-
<td></td>
825+
<td>This option determines whether or with what priority a secure GSS
826+
TCP/IP connection will be negotiated with the server.</td>
807827
</tr>
808828
<tr class="odd">
809829
<td>ca_cert_path</td>
810830
<td></td>
811-
<td></td>
831+
<td>Path to CA certificate</td>
812832
</tr>
813833
</tbody>
814834
</table>

docs/config.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -273,18 +273,28 @@ model context protocol server configuration.
273273

274274
PostgreSQL database configuration.
275275

276+
PostgreSQL database is used by Lightspeed Core Stack service for storing information about
277+
conversation IDs. It can also be leveraged to store conversation history and information
278+
about quota usage.
279+
280+
Useful resources:
281+
282+
- [Psycopg: connection classes](https://www.psycopg.org/psycopg3/docs/api/connections.html)
283+
- [PostgreSQL connection strings](https://www.connectionstrings.com/postgresql/)
284+
- [How to Use PostgreSQL in Python](https://www.freecodecamp.org/news/postgresql-in-python/)
285+
276286

277287
| Field | Type | Description |
278288
|-------|------|-------------|
279-
| host | string | |
280-
| port | integer | |
281-
| db | string | |
282-
| user | string | |
283-
| password | string | |
284-
| namespace | | |
285-
| ssl_mode | string | |
286-
| gss_encmode | string | |
287-
| ca_cert_path | | |
289+
| host | string | Database server host or socket directory |
290+
| port | integer | Database server port |
291+
| db | string | Database name to connect to |
292+
| user | string | Database user name used to authenticate |
293+
| password | string | Password used to authenticate |
294+
| namespace | | Database namespace |
295+
| ssl_mode | string | SSL mode |
296+
| gss_encmode | string | This option determines whether or with what priority a secure GSS TCP/IP connection will be negotiated with the server. |
297+
| ca_cert_path | | Path to CA certificate |
288298

289299

290300
## QuotaHandlersConfiguration

docs/config.puml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -127,14 +127,14 @@ class "ModelContextProtocolServer" as src.models.config.ModelContextProtocolServ
127127
}
128128
class "PostgreSQLDatabaseConfiguration" as src.models.config.PostgreSQLDatabaseConfiguration {
129129
ca_cert_path : Optional[FilePath]
130-
db : str
131-
gss_encmode : str
132-
host : str
130+
db : Optional[str]
131+
gss_encmode : Optional[str]
132+
host : Optional[str]
133133
namespace : Optional[str]
134-
password : SecretStr
135-
port : Annotated
136-
ssl_mode : str
137-
user : str
134+
password : Optional[SecretStr]
135+
port : Optional[PositiveInt]
136+
ssl_mode : Optional[str]
137+
user : Optional[str]
138138
check_postgres_configuration() -> Self
139139
}
140140
class "QuotaHandlersConfiguration" as src.models.config.QuotaHandlersConfiguration {

0 commit comments

Comments
 (0)