Skip to content

[Backport 8.12] Add doc for closing connections #2105

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 1 commit into from
Dec 14, 2023
Merged

[Backport 8.12] Add doc for closing connections #2105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions docs/connecting.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ This page contains the information you need to connect and use the Client with
* <<client-connect-proxy, Connecting through a proxy>>
* <<client-error-handling, Handling errors>>
* <<keep-alive, Keep-alive connections>>
* <<close-connections, Closing a client's connections>>
* <<product-check, Automatic product check>>

[[authentication]]
Expand Down Expand Up @@ -691,6 +692,20 @@ const client = new Client({
})
----

[discrete]
[[close-connections]]
=== Closing a client's connections

If you would like to close all open connections being managed by an instance of the client, use the `close()` function:

[source,js]
----
const client = new Client({
node: 'http://localhost:9200'
});
client.close();
----

[discrete]
[[product-check]]
=== Automatic product check
Expand Down