Skip to content

Commit 7f84c3e

Browse files
Mats-SXDarthMax
andcommitted
Add parameter documentation
Co-authored-by: Max Kießling <max.kiessling@neotechnology.com>
1 parent 8c6ce6b commit 7f84c3e

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

doc/modules/ROOT/pages/graph-analytics-serverless.adoc

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,19 +86,23 @@ sessions.get_or_create(
8686
ttl: Optional[timedelta] = None,
8787
cloud_location: Optional[CloudLocation] = None,
8888
timeout: Optional[int] = None,
89+
tls_root_certs: Optional[bytes] = None,
90+
disable_server_verification: bool = False,
8991
): AuraGraphDataScience
9092
----
9193

9294
.Parameters:
9395
[opts="header",cols="3m,1m,1,1m,6", role="no-break"]
9496
|===
95-
| Name | Type | Optional | Default | Description
96-
| session_name | str | no | - | Name of the session. Must be unique within the project.
97-
| memory | https://neo4j.com/docs/graph-data-science-client/{docs-version}/api/sessions/session_memory[SessionMemory] | no | - | Amount of memory available to the session.
98-
| db_connection | https://neo4j.com/docs/graph-data-science-client/{docs-version}/api/sessions/DbmsConnectionInfo[DbmsConnectionInfo] | yes | None | Bolt server URL, username, and password to a Neo4j DBMS. Required for the Attached and Self-managed types. Alternatively to username and password, you can provide a `neo4j.Auth` https://neo4j.com/docs/python-manual/current/connect-advanced/#authentication-methods[object].
99-
| ttl | datetime.timedelta | yes | 1h | Time-to-live for the session.
100-
| cloud_location| https://neo4j.com/docs/graph-data-science-client/{docs-version}/api/sessions/cloud_location[CloudLocation] | yes | None | Aura-supported cloud provider and region where the GDS Session will run. Required for the Self-managed and Standalone types.
101-
| timeout | int | yes | None | Seconds to wait for the session to enter Ready state. If the time is exceeded, an error will be returned.
97+
| Name | Type | Optional | Default | Description
98+
| session_name | str | no | - | Name of the session. Must be unique within the project.
99+
| memory | https://neo4j.com/docs/graph-data-science-client/{docs-version}/api/sessions/session_memory[SessionMemory] | no | - | Amount of memory available to the session.
100+
| db_connection | https://neo4j.com/docs/graph-data-science-client/{docs-version}/api/sessions/DbmsConnectionInfo[DbmsConnectionInfo] | yes | None | Bolt server URL, username, and password to a Neo4j DBMS. Required for the Attached and Self-managed types. Alternatively to username and password, you can provide a `neo4j.Auth` https://neo4j.com/docs/python-manual/current/connect-advanced/#authentication-methods[object].
101+
| ttl | datetime.timedelta | yes | 1h | Time-to-live for the session.
102+
| cloud_location | https://neo4j.com/docs/graph-data-science-client/{docs-version}/api/sessions/cloud_location[CloudLocation] | yes | None | Aura-supported cloud provider and region where the GDS Session will run. Required for the Self-managed and Standalone types.
103+
| timeout | int | yes | None | Seconds to wait for the session to enter Ready state. If the time is exceeded, an error will be returned.
104+
| tls_root_certs | bytes | yes | None | PEM-encoded root certificates used for verifying server certificate. If not specified, platform-specific default root certificates will be used.
105+
| disable_server_verification | bool | yes | False | Set to True to disable server TLS certificate verification. Use with caution.
102106
|===
103107

104108

0 commit comments

Comments
 (0)