= Cheatsheets

[[Box]]
== Box

++++
Rectangular box data type in Postgres represented by pairs of links that are opposite corners of the box.
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[lowerLeftCorner]]`@lowerLeftCorner`|`link:dataobjects.html#Point[Point]`|-
|[[upperRightCorner]]`@upperRightCorner`|`link:dataobjects.html#Point[Point]`|-
|===

[[Circle]]
== Circle

++++
Circle data type in Postgres represented by a center link and radius.
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[centerPoint]]`@centerPoint`|`link:dataobjects.html#Point[Point]`|-
|[[radius]]`@radius`|`Number (double)`|-
|===

[[Interval]]
== Interval

++++
Postgres Interval is date and time based
such as 120 years 3 months 332 days 20 hours 20 minutes 20.999999 seconds
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[days]]`@days`|`Number (int)`|-
|[[hours]]`@hours`|`Number (int)`|-
|[[microseconds]]`@microseconds`|`Number (int)`|-
|[[minutes]]`@minutes`|`Number (int)`|-
|[[months]]`@months`|`Number (int)`|-
|[[seconds]]`@seconds`|`Number (int)`|-
|[[years]]`@years`|`Number (int)`|-
|===

[[Line]]
== Line

++++
Line data type in Postgres represented by the linear equation Ax + By + C = 0, where A and B are not both zero.
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[a]]`@a`|`Number (double)`|-
|[[b]]`@b`|`Number (double)`|-
|[[c]]`@c`|`Number (double)`|-
|===

[[LineSegment]]
== LineSegment

++++
Finite line segment data type in Postgres represented by pairs of links that are the endpoints of the segment.
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[p1]]`@p1`|`link:dataobjects.html#Point[Point]`|-
|[[p2]]`@p2`|`link:dataobjects.html#Point[Point]`|-
|===

[[Path]]
== Path

++++
Path data type in Postgres represented by lists of connected points.
Paths can be open, where the first and last points in the list are considered not connected,
or closed, where the first and last points are considered connected.
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[open]]`@open`|`Boolean`|-
|[[points]]`@points`|`Array of link:dataobjects.html#Point[Point]`|-
|===

[[PgConnectOptions]]
== PgConnectOptions

++++
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[cachePreparedStatements]]`@cachePreparedStatements`|`Boolean`|-
|[[connectTimeout]]`@connectTimeout`|`Number (int)`|-
|[[crlPaths]]`@crlPaths`|`Array of String`|-
|[[crlValues]]`@crlValues`|`Array of Buffer`|-
|[[database]]`@database`|`String`|-
|[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|-
|[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|-
|[[host]]`@host`|`String`|-
|[[hostnameVerificationAlgorithm]]`@hostnameVerificationAlgorithm`|`String`|-
|[[idleTimeout]]`@idleTimeout`|`Number (int)`|-
|[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|-
|[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|-
|[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[localAddress]]`@localAddress`|`String`|-
|[[logActivity]]`@logActivity`|`Boolean`|-
|[[metricsName]]`@metricsName`|`String`|-
|[[openSslEngineOptions]]`@openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|-
|[[password]]`@password`|`String`|-
|[[pemKeyCertOptions]]`@pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|-
|[[pemTrustOptions]]`@pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|-
|[[pfxKeyCertOptions]]`@pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[pfxTrustOptions]]`@pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[pipeliningLimit]]`@pipeliningLimit`|`Number (int)`|-
|[[port]]`@port`|`Number (int)`|-
|[[preparedStatementCacheMaxSize]]`@preparedStatementCacheMaxSize`|`Number (int)`|-
|[[preparedStatementCacheSqlLimit]]`@preparedStatementCacheSqlLimit`|`Number (int)`|-
|[[properties]]`@properties`|`String`|-
|[[proxyOptions]]`@proxyOptions`|`link:dataobjects.html#ProxyOptions[ProxyOptions]`|-
|[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|-
|[[reconnectAttempts]]`@reconnectAttempts`|`Number (int)`|-
|[[reconnectInterval]]`@reconnectInterval`|`Number (long)`|-
|[[reuseAddress]]`@reuseAddress`|`Boolean`|-
|[[reusePort]]`@reusePort`|`Boolean`|-
|[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|-
|[[soLinger]]`@soLinger`|`Number (int)`|-
|[[ssl]]`@ssl`|`Boolean`|-
|[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|-
|[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|-
|[[sslMode]]`@sslMode`|`link:enums.html#SslMode[SslMode]`|+++
Set link for the client, this option can be used to provide different levels of secure protection.
+++
|[[tcpCork]]`@tcpCork`|`Boolean`|-
|[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|-
|[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|-
|[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|-
|[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|-
|[[trafficClass]]`@trafficClass`|`Number (int)`|-
|[[trustAll]]`@trustAll`|`Boolean`|-
|[[trustStoreOptions]]`@trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[useAlpn]]`@useAlpn`|`Boolean`|-
|[[usePooledBuffers]]`@usePooledBuffers`|`Boolean`|-
|[[user]]`@user`|`String`|-
|[[usingDomainSocket]]`@usingDomainSocket`|`Boolean`|-
|===

[[PgNotification]]
== PgNotification

++++
A notification emited by Postgres.
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[channel]]`@channel`|`String`|+++
Set the channel value.
+++
|[[payload]]`@payload`|`String`|+++
Set the payload value.
+++
|[[processId]]`@processId`|`Number (int)`|+++
Set the process id.
+++
|===

[[Point]]
== Point

++++
A Postgresql point.
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[x]]`@x`|`Number (double)`|-
|[[y]]`@y`|`Number (double)`|-
|===

[[Polygon]]
== Polygon

++++
Polygon data type in Postgres represented by lists of points (the vertexes of the polygon).
Polygons are very similar to closed paths, but are stored differently and have their own set of support routines.
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[points]]`@points`|`Array of link:dataobjects.html#Point[Point]`|-
|===