Documentation on storage parameters (#312)

Original commit: c01d288
npgsql · Oct 28, 2023 · 0815add · 0815add
1 parent bc80a6f
commit 0815add
Show file tree

Hide file tree

Showing 428 changed files with 2,944 additions and 2,926 deletions.
diff --git a/doc/api/Microsoft.Extensions.DependencyInjection.NpgsqlServiceCollectionExtensions.html b/doc/api/Microsoft.Extensions.DependencyInjection.NpgsqlServiceCollectionExtensions.html
@@ -94,10 +94,10 @@ <h1 id="Microsoft_Extensions_DependencyInjection_NpgsqlServiceCollectionExtensio
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
  <h5>Inheritance</h5>
- <div class="level0"><span class="xref">object</span></div>
+ <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
  <div class="level1"><span class="xref">NpgsqlServiceCollectionExtensions</span></div>
  </div>
- <h6><strong>Namespace</strong>: <span class="xref">Microsoft</span>.<span class="xref">Extensions</span>.<a class="xref" href="../../efcore/api/Microsoft.Extensions.DependencyInjection.html">DependencyInjection</a></h6>
+ <h6><strong>Namespace</strong>: <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft">Microsoft</a>.<span class="xref">Extensions</span>.<a class="xref" href="../../efcore/api/Microsoft.Extensions.DependencyInjection.html">DependencyInjection</a></h6>
  <h6><strong>Assembly</strong>: Npgsql.DependencyInjection.dll</h6>
  <h5 id="Microsoft_Extensions_DependencyInjection_NpgsqlServiceCollectionExtensions_syntax">Syntax</h5>
  <div class="codewrapper">
@@ -138,7 +138,7 @@ <h5 class="parameters">Parameters</h5>
 </td>
  </tr>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">connectionString</span></td>
  <td><p>An Npgsql connection string.</p>
 </td>
@@ -215,7 +215,7 @@ <h5 class="parameters">Parameters</h5>
 </td>
  </tr>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">connectionString</span></td>
  <td><p>An Npgsql connection string.</p>
 </td>
@@ -285,7 +285,7 @@ <h5 class="parameters">Parameters</h5>
 </td>
  </tr>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">connectionString</span></td>
  <td><p>An Npgsql connection string.</p>
 </td>
@@ -362,7 +362,7 @@ <h5 class="parameters">Parameters</h5>
 </td>
  </tr>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">connectionString</span></td>
  <td><p>An Npgsql connection string.</p>
 </td>
@@ -432,7 +432,7 @@ <h5 class="parameters">Parameters</h5>
 </td>
  </tr>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">connectionString</span></td>
  <td><p>An Npgsql connection string.</p>
 </td>
@@ -508,7 +508,7 @@ <h5 class="parameters">Parameters</h5>
 </td>
  </tr>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">connectionString</span></td>
  <td><p>An Npgsql connection string.</p>
 </td>
@@ -578,7 +578,7 @@ <h5 class="parameters">Parameters</h5>
 </td>
  </tr>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">connectionString</span></td>
  <td><p>An Npgsql connection string.</p>
 </td>
@@ -654,7 +654,7 @@ <h5 class="parameters">Parameters</h5>
 </td>
  </tr>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">connectionString</span></td>
  <td><p>An Npgsql connection string.</p>
 </td>

diff --git a/doc/api/Npgsql.BackendMessages.FieldDescription.html b/doc/api/Npgsql.BackendMessages.FieldDescription.html
@@ -95,7 +95,7 @@ <h1 id="Npgsql_BackendMessages_FieldDescription" data-uid="Npgsql.BackendMessage
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
  <h5>Inheritance</h5>
- <div class="level0"><span class="xref">object</span></div>
+ <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
  <div class="level1"><span class="xref">FieldDescription</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="Npgsql.html">Npgsql</a>.<a class="xref" href="Npgsql.BackendMessages.html">BackendMessages</a></h6>
@@ -163,7 +163,7 @@ <h5 class="propertyValue">Property Value</h5>
  </thead>
  <tbody>
  <tr>
- <td><span class="xref">short</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int16">short</a></td>
  <td></td>
  </tr>
  </tbody>
@@ -196,7 +196,7 @@ <h5 class="returns">Returns</h5>
  </thead>
  <tbody>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td></td>
  </tr>
  </tbody>

diff --git a/doc/api/Npgsql.GeoJSON.CrsMap.html b/doc/api/Npgsql.GeoJSON.CrsMap.html
@@ -94,7 +94,7 @@ <h1 id="Npgsql_GeoJSON_CrsMap" data-uid="Npgsql.GeoJSON.CrsMap" class="text-brea
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
  <h5>Inheritance</h5>
- <div class="level0"><span class="xref">object</span></div>
+ <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
  <div class="level1"><span class="xref">CrsMap</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="Npgsql.html">Npgsql</a>.<a class="xref" href="Npgsql.GeoJSON.html">GeoJSON</a></h6>

diff --git a/doc/api/Npgsql.GeoJSON.CrsMapExtensions.html b/doc/api/Npgsql.GeoJSON.CrsMapExtensions.html
@@ -94,7 +94,7 @@ <h1 id="Npgsql_GeoJSON_CrsMapExtensions" data-uid="Npgsql.GeoJSON.CrsMapExtensio
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
  <h5>Inheritance</h5>
- <div class="level0"><span class="xref">object</span></div>
+ <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
  <div class="level1"><span class="xref">CrsMapExtensions</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="Npgsql.html">Npgsql</a>.<a class="xref" href="Npgsql.GeoJSON.html">GeoJSON</a></h6>

diff --git a/doc/api/Npgsql.INpgsqlNameTranslator.html b/doc/api/Npgsql.INpgsqlNameTranslator.html
@@ -129,7 +129,7 @@ <h5 class="parameters">Parameters</h5>
  </thead>
  <tbody>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">clrName</span></td>
  <td></td>
  </tr>
@@ -145,7 +145,7 @@ <h5 class="returns">Returns</h5>
  </thead>
  <tbody>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td></td>
  </tr>
  </tbody>
@@ -177,7 +177,7 @@ <h5 class="parameters">Parameters</h5>
  </thead>
  <tbody>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">clrName</span></td>
  <td></td>
  </tr>
@@ -193,7 +193,7 @@ <h5 class="returns">Returns</h5>
  </thead>
  <tbody>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td></td>
  </tr>
  </tbody>

diff --git a/doc/api/Npgsql.INpgsqlTypeMapperExtensions.html b/doc/api/Npgsql.INpgsqlTypeMapperExtensions.html
@@ -94,7 +94,7 @@ <h1 id="Npgsql_INpgsqlTypeMapperExtensions" data-uid="Npgsql.INpgsqlTypeMapperEx
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
  <h5>Inheritance</h5>
- <div class="level0"><span class="xref">object</span></div>
+ <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
  <div class="level1"><span class="xref">INpgsqlTypeMapperExtensions</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="Npgsql.html">Npgsql</a></h6>

diff --git a/doc/api/Npgsql.Internal.BufferRequirements.html b/doc/api/Npgsql.Internal.BufferRequirements.html
@@ -590,7 +590,7 @@ <h5 class="parameters">Parameters</h5>
  </thead>
  <tbody>
  <tr>
- <td><span class="xref">object</span>?</td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>?</td>
  <td><span class="parametername">obj</span></td>
  <td></td>
  </tr>

diff --git a/doc/api/Npgsql.Internal.DynamicTypeInfoResolver.DynamicMappingCollection.html b/doc/api/Npgsql.Internal.DynamicTypeInfoResolver.DynamicMappingCollection.html
@@ -93,7 +93,7 @@ <h1 id="Npgsql_Internal_DynamicTypeInfoResolver_DynamicMappingCollection" data-u
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
  <h5>Inheritance</h5>
- <div class="level0"><span class="xref">object</span></div>
+ <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
  <div class="level1"><span class="xref">DynamicTypeInfoResolver.DynamicMappingCollection</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="Npgsql.html">Npgsql</a>.<a class="xref" href="Npgsql.Internal.html">Internal</a></h6>
@@ -135,7 +135,7 @@ <h5 class="parameters">Parameters</h5>
  <td></td>
  </tr>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">dataTypeName</span></td>
  <td></td>
  </tr>
@@ -187,7 +187,7 @@ <h5 class="parameters">Parameters</h5>
  <td></td>
  </tr>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">dataTypeName</span></td>
  <td></td>
  </tr>
@@ -249,7 +249,7 @@ <h5 class="parameters">Parameters</h5>
  <td></td>
  </tr>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">dataTypeName</span></td>
  <td></td>
  </tr>
@@ -301,7 +301,7 @@ <h5 class="parameters">Parameters</h5>
  <td></td>
  </tr>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">dataTypeName</span></td>
  <td></td>
  </tr>

diff --git a/doc/api/Npgsql.Internal.DynamicTypeInfoResolver.html b/doc/api/Npgsql.Internal.DynamicTypeInfoResolver.html
@@ -93,7 +93,7 @@ <h1 id="Npgsql_Internal_DynamicTypeInfoResolver" data-uid="Npgsql.Internal.Dynam
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
  <h5>Inheritance</h5>
- <div class="level0"><span class="xref">object</span></div>
+ <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
  <div class="level1"><span class="xref">DynamicTypeInfoResolver</span></div>
  </div>
  <div class="implements">

diff --git a/doc/api/Npgsql.Internal.HackyEnumTypeMapping.html b/doc/api/Npgsql.Internal.HackyEnumTypeMapping.html
@@ -94,7 +94,7 @@ <h1 id="Npgsql_Internal_HackyEnumTypeMapping" data-uid="Npgsql.Internal.HackyEnu
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
  <h5>Inheritance</h5>
- <div class="level0"><span class="xref">object</span></div>
+ <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
  <div class="level1"><span class="xref">HackyEnumTypeMapping</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="Npgsql.html">Npgsql</a>.<a class="xref" href="Npgsql.Internal.html">Internal</a></h6>
@@ -136,7 +136,7 @@ <h5 class="parameters">Parameters</h5>
  <td></td>
  </tr>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">pgTypeName</span></td>
  <td></td>
  </tr>
@@ -234,7 +234,7 @@ <h5 class="propertyValue">Property Value</h5>
  </thead>
  <tbody>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td></td>
  </tr>
  </tbody>

diff --git a/doc/api/Npgsql.Internal.NpgsqlConnector.html b/doc/api/Npgsql.Internal.NpgsqlConnector.html
@@ -95,7 +95,7 @@ <h1 id="Npgsql_Internal_NpgsqlConnector" data-uid="Npgsql.Internal.NpgsqlConnect
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
  <h5>Inheritance</h5>
- <div class="level0"><span class="xref">object</span></div>
+ <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
  <div class="level1"><span class="xref">NpgsqlConnector</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="Npgsql.html">Npgsql</a>.<a class="xref" href="Npgsql.Internal.html">Internal</a></h6>
@@ -259,7 +259,7 @@ <h5 class="parameters">Parameters</h5>
  </thead>
  <tbody>
  <tr>
- <td><span class="xref">string</span>?</td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>?</td>
  <td><span class="parametername">cmdText</span></td>
  <td><p>The text of the query.</p>
 </td>

diff --git a/doc/api/Npgsql.Internal.NpgsqlDatabaseInfo.html b/doc/api/Npgsql.Internal.NpgsqlDatabaseInfo.html
@@ -95,7 +95,7 @@ <h1 id="Npgsql_Internal_NpgsqlDatabaseInfo" data-uid="Npgsql.Internal.NpgsqlData
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
  <h5>Inheritance</h5>
- <div class="level0"><span class="xref">object</span></div>
+ <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
  <div class="level1"><span class="xref">NpgsqlDatabaseInfo</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="Npgsql.html">Npgsql</a>.<a class="xref" href="Npgsql.Internal.html">Internal</a></h6>
@@ -133,7 +133,7 @@ <h5 class="parameters">Parameters</h5>
  </thead>
  <tbody>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">host</span></td>
  <td></td>
  </tr>
@@ -143,7 +143,7 @@ <h5 class="parameters">Parameters</h5>
  <td></td>
  </tr>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">databaseName</span></td>
  <td></td>
  </tr>
@@ -153,7 +153,7 @@ <h5 class="parameters">Parameters</h5>
  <td></td>
  </tr>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">serverVersion</span></td>
  <td></td>
  </tr>
@@ -186,7 +186,7 @@ <h5 class="parameters">Parameters</h5>
  </thead>
  <tbody>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">host</span></td>
  <td></td>
  </tr>
@@ -196,7 +196,7 @@ <h5 class="parameters">Parameters</h5>
  <td></td>
  </tr>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">databaseName</span></td>
  <td></td>
  </tr>
@@ -266,7 +266,7 @@ <h5 class="propertyValue">Property Value</h5>
  </thead>
  <tbody>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td></td>
  </tr>
  </tbody>
@@ -297,7 +297,7 @@ <h5 class="propertyValue">Property Value</h5>
  </thead>
  <tbody>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td></td>
  </tr>
  </tbody>
@@ -359,7 +359,7 @@ <h5 class="propertyValue">Property Value</h5>
  </thead>
  <tbody>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td></td>
  </tr>
  </tbody>
@@ -734,7 +734,7 @@ <h5 class="parameters">Parameters</h5>
  </thead>
  <tbody>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">pgName</span></td>
  <td></td>
  </tr>
@@ -781,7 +781,7 @@ <h5 class="parameters">Parameters</h5>
  </thead>
  <tbody>
  <tr>
- <td><span class="xref">uint</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint32">uint</a></td>
  <td><span class="parametername">oid</span></td>
  <td></td>
  </tr>
@@ -860,7 +860,7 @@ <h5 class="parameters">Parameters</h5>
  </thead>
  <tbody>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">value</span></td>
  <td></td>
  </tr>
@@ -940,7 +940,7 @@ <h5 class="parameters">Parameters</h5>
  </thead>
  <tbody>
  <tr>
- <td><span class="xref">string</span></td>
+ <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
  <td><span class="parametername">pgName</span></td>
  <td></td>
  </tr>