Skip to content

API docs: Fix execute_query parameter names #1087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 16, 2024
Merged

API docs: Fix execute_query parameter names #1087

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9433d9c
API docs: Fix execute_query parameter names
robsdedude Aug 14, 2024
b96f77b
Merge branch '5.0' into fix/docs/execute-query-parameter-names
robsdedude Aug 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions docs/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,18 +246,18 @@ Closing a driver will immediately shut down all connections in the pool.
assert isinstance(count, int)
return count

:param query_:
:param query:
Cypher query to execute.
Use a :class:`.Query` object to pass a query with additional
transaction configuration.
:type query_: typing.LiteralString | Query
:param parameters_: parameters to use in the query
:type parameters_: typing.Dict[str, typing.Any] | None
:param routing_:
:type query: typing.LiteralString | Query
:param parameters\_: parameters to use in the query
:type parameters\_: typing.Dict[str, typing.Any] | None
:param routing\_:
Whether to route the query to a reader (follower/read replica) or
a writer (leader) in the cluster. Default is to route to a writer.
:type routing_: RoutingControl
:param database_:
:type routing\_: RoutingControl
:param database\_:
Database to execute the query against.

None (default) uses the database configured on the server side.
Expand All @@ -268,8 +268,8 @@ Closing a driver will immediately shut down all connections in the pool.
as it will not have to resolve the default database first.

See also the Session config :ref:`database-ref`.
:type database_: str | None
:param impersonated_user_:
:type database\_: str | None
:param impersonated_user\_:
Name of the user to impersonate.

This means that all query will be executed in the security context
Expand All @@ -278,15 +278,15 @@ Closing a driver will immediately shut down all connections in the pool.
permissions.

See also the Session config :ref:`impersonated-user-ref`.
:type impersonated_user_: str | None
:param auth_:
:type impersonated_user\_: str | None
:param auth\_:
Authentication information to use for this query.

By default, the driver configuration is used.

See also the Session config :ref:`session-auth-ref`.
:type auth_: typing.Tuple[typing.Any, typing.Any] | Auth | None
:param result_transformer_:
:type auth\_: typing.Tuple[typing.Any, typing.Any] | Auth | None
:param result_transformer\_:
A function that gets passed the :class:`neo4j.Result` object
resulting from the query and converts it to a different type. The
result of the transformer function is returned by this method.
Expand Down Expand Up @@ -346,9 +346,9 @@ Closing a driver will immediately shut down all connections in the pool.
result_transformer_=transformer
)

:type result_transformer_:
:type result_transformer\_:
typing.Callable[[Result], T]
:param bookmark_manager_:
:param bookmark_manager\_:
Specify a bookmark manager to use.

If present, the bookmark manager is used to keep the query causally
Expand All @@ -357,7 +357,7 @@ Closing a driver will immediately shut down all connections in the pool.
Defaults to the driver's :attr:`.execute_query_bookmark_manager`.

Pass :data:`None` to disable causal consistency.
:type bookmark_manager_: BookmarkManager | None
:type bookmark_manager\_: BookmarkManager | None
:param kwargs: additional keyword parameters. None of these can end
with a single underscore. This is to avoid collisions with the
keyword configuration parameters of this method. If you need to
Expand Down
32 changes: 16 additions & 16 deletions docs/source/async_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,18 +233,18 @@ Closing a driver will immediately shut down all connections in the pool.
assert isinstance(count, int)
return count

:param query_:
:param query:
Cypher query to execute.
Use a :class:`.Query` object to pass a query with additional
transaction configuration.
:type query_: typing.LiteralString | Query
:param parameters_: parameters to use in the query
:type parameters_: typing.Dict[str, typing.Any] | None
:param routing_:
:type query: typing.LiteralString | Query
:param parameters\_: parameters to use in the query
:type parameters\_: typing.Dict[str, typing.Any] | None
:param routing\_:
Whether to route the query to a reader (follower/read replica) or
a writer (leader) in the cluster. Default is to route to a writer.
:type routing_: RoutingControl
:param database_:
:type routing\_: RoutingControl
:param database\_:
Database to execute the query against.

None (default) uses the database configured on the server side.
Expand All @@ -255,8 +255,8 @@ Closing a driver will immediately shut down all connections in the pool.
as it will not have to resolve the default database first.

See also the Session config :ref:`database-ref`.
:type database_: str | None
:param impersonated_user_:
:type database\_: str | None
:param impersonated_user\_:
Name of the user to impersonate.

This means that all query will be executed in the security context
Expand All @@ -265,15 +265,15 @@ Closing a driver will immediately shut down all connections in the pool.
permissions.

See also the Session config :ref:`impersonated-user-ref`.
:type impersonated_user_: str | None
:param auth_:
:type impersonated_user\_: str | None
:param auth\_:
Authentication information to use for this query.

By default, the driver configuration is used.

See also the Session config :ref:`session-auth-ref`.
:type auth_: typing.Tuple[typing.Any, typing.Any] | Auth | None
:param result_transformer_:
:type auth\_: typing.Tuple[typing.Any, typing.Any] | Auth | None
:param result_transformer\_:
A function that gets passed the :class:`neo4j.AsyncResult` object
resulting from the query and converts it to a different type. The
result of the transformer function is returned by this method.
Expand Down Expand Up @@ -333,9 +333,9 @@ Closing a driver will immediately shut down all connections in the pool.
result_transformer_=transformer
)

:type result_transformer_:
:type result_transformer\_:
typing.Callable[[AsyncResult], typing.Awaitable[T]]
:param bookmark_manager_:
:param bookmark_manager\_:
Specify a bookmark manager to use.

If present, the bookmark manager is used to keep the query causally
Expand All @@ -344,7 +344,7 @@ Closing a driver will immediately shut down all connections in the pool.
Defaults to the driver's :attr:`.execute_query_bookmark_manager`.

Pass :data:`None` to disable causal consistency.
:type bookmark_manager_: AsyncBookmarkManager | BookmarkManager | None
:type bookmark_manager\_: AsyncBookmarkManager | BookmarkManager | None
:param kwargs: additional keyword parameters. None of these can end
with a single underscore. This is to avoid collisions with the
keyword configuration parameters of this method. If you need to
Expand Down