Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vitaly-t committed Jul 5, 2024
1 parent bedcb9e commit e921abb
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions Database.html
Original file line number Diff line number Diff line change
Expand Up @@ -557,9 +557,9 @@ <h4 class="name" id="$pool"><span class="type-signature">(readonly) </span>$pool


<div class="description">
<p>A <a href="https://github.com/brianc/node-pg-pool">pg-pool</a> object associated with the database object, as each <a href="Database.html">Database</a> creates its own <a href="https://github.com/brianc/node-pg-pool">pg-pool</a> instance.</p>
<p>A <a href="https://github.com/brianc/node-postgres/tree/master/packages/pg-pool">pg-pool</a> object associated with the database object, as each <a href="Database.html">Database</a> creates its own <a href="https://github.com/brianc/node-postgres/tree/master/packages/pg-pool">pg-pool</a> instance.</p>
<p>This is a hidden property, primarily for integrating type <a href="Database.html">Database</a> with third-party libraries that support
<a href="https://github.com/brianc/node-pg-pool">pg-pool</a> directly. Note however, that if you pass the pool object into a library that calls <code>pool.end()</code>, you will no longer be able
<a href="https://github.com/brianc/node-postgres/tree/master/packages/pg-pool">pg-pool</a> directly. Note however, that if you pass the pool object into a library that calls <code>pool.end()</code>, you will no longer be able
to use this <a href="Database.html">Database</a> object, and each query method will be rejecting with <a href="external-Error.html">Error</a> =
<code>Connection pool of the database object has been destroyed.</code></p>
<p>You can also use this object to shut down the pool, by calling <code>$pool.end()</code>.</p>
Expand Down Expand Up @@ -4906,7 +4906,7 @@ <h4 class="name" id="stream"><span class="type-signature"></span>stream<span cla


<div class="description">
<p>Custom data streaming, with the help of <a href="https://github.com/brianc/node-pg-query-stream">pg-query-stream</a>.</p>
<p>Custom data streaming, with the help of <a href="https://github.com/brianc/node-postgres/tree/master/packages/pg-query-stream">pg-query-stream</a>.</p>
<p>This method doesn't work with the <a href="https://node-postgres.com/features/native">Native Bindings</a>, and if option <code>pgNative</code>
is set, it will reject with <code>Streaming doesn't work with Native Bindings.</code></p>
</div>
Expand Down Expand Up @@ -4960,7 +4960,7 @@ <h5>Parameters:</h5>



<td class="description last"><p>Stream object of type <a href="https://github.com/brianc/node-pg-query-stream/blob/master/index.js#L5">QueryStream</a>.</p></td>
<td class="description last"><p>Stream object of type <a href="https://github.com/brianc/node-postgres/blob/master/packages/pg-query-stream/src/index.ts">QueryStream</a>.</p></td>
</tr>


Expand Down
2 changes: 1 addition & 1 deletion module-pg-promise.html
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ <h6>Properties</h6>
</td>


<td class="description last"><p>Use <a href="https://node-postgres.com/features/native">Native Bindings</a>. Library <a href="https://github.com/brianc/node-pg-native">pg-native</a> must be included and installed independently, or else there will
<td class="description last"><p>Use <a href="https://node-postgres.com/features/native">Native Bindings</a>. Library <a href="https://github.com/brianc/node-postgres/tree/master/packages/pg-native">pg-native</a> must be included and installed independently, or else there will
be an error thrown: <a href="external-Error.html">Error</a> = <code>Failed to initialize Native Bindings.</code></p>
<p>This is a static option (can only be set prior to initialization).</p></td>
</tr>
Expand Down

0 comments on commit e921abb

Please sign in to comment.