# Amazon Athena PostgreSQL 连接器
<a name="connectors-postgresql"></a>

Amazon Athena PostgreSQL 连接器使 Athena 可以访问 PostgreSQL 数据库。

此连接器可以作为联合目录注册到 Glue Data Catalog。此连接器支持 Lake Formation 中在目录、数据库、行和标签级别定义的数据访问控制。此连接器使用 Glue 连接将配置属性集中保存到 Glue 中。

## 先决条件
<a name="connectors-postgres-prerequisites"></a>
+ 可以使用 Athena 控制台或 AWS Serverless Application Repository 将该连接器部署到您的 AWS 账户。有关更多信息，请参阅 [创建数据来源连接](connect-to-a-data-source.md) 或 [使用 AWS Serverless Application Repository 部署数据来源连接器](connect-data-source-serverless-app-repo.md)。

## 限制
<a name="connectors-postgresql-limitations"></a>
+ 不支持写入 DDL 操作。
+ 在多路复用器设置中，溢出桶和前缀在所有数据库实例之间共享。
+ 任何相关的 Lambda 限制。有关更多信息，请参阅《*AWS Lambda 开发人员指南*》中的 [Lambda 配额](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html)。
+ 与 PostgreSQL 一样，出于长度和比较的目的，Athena 将 PostgreSQL `CHAR` 类型中的尾随空格视为在语义上无关紧要。请注意，这仅适用于 `CHAR`，但不适用于 `VARCHAR` 类型。Athena 会忽略 `CHAR` 类型的尾随空格，但将其视为对 `VARCHAR` 类型很重要。
+ 使用 [citext](https://www.postgresql.org/docs/current/citext.html) 不区分大小写的字符串数据类型时，PostgreSQL 会使用与 Athena 不同的不区分大小写的数据比较。这种差异在 SQL `JOIN` 操作过程中会产生数据差异。要解决此问题，请使用 PostgreSQL 连接器传递查询功能。有关更多信息，请参阅本文档后面的[传递查询](#connectors-postgres-passthrough-queries)部分。

## 术语
<a name="connectors-postgresql-terms"></a>

以下术语和概念与 PostgreSQL 连接器有关。
+ **数据库实例** - 部署在本地、Amazon EC2 或 Amazon RDS 上的任何数据库实例。
+ **处理程序** — 访问您数据库实例的 Lambda 处理程序。处理程序可以用于元数据或数据记录。
+ **元数据处理程序** — 从您的数据库实例中检索元数据的 Lambda 处理程序。
+ **记录处理程序** — 从您的数据库实例中检索数据记录的 Lambda 处理程序。
+ **复合处理程序** — 从您的数据库实例中检索元数据和数据记录的 Lambda 处理程序。
+ **属性或参数** — 处理程序用来提取数据库信息的数据库属性。您可以将这些属性配置为 Lambda 环境变量。
+ **连接字符串** — 用于建立数据库实例连接的文本字符串。
+ **目录** — 向 Athena 注册的非 AWS Glue 目录，是 `connection_string` 属性的必要前缀。
+ **多路复用处理程序** — 可以接受和使用多个数据库连接的 Lambda 处理程序。

## 参数
<a name="connectors-postgresql-parameters"></a>

使用本节中的参数来配置 PostgreSQL 连接器。

**注意**  
2024 年 12 月 3 日及之后创建的 Athena 数据来源连接器使用 AWS Glue 连接。

### Glue 连接（推荐）
<a name="connectors-postgresql-gc"></a>

我们建议您使用 Glue 连接对象来配置 PostgreSQL 连接器。

要执行此操作，请将 PostgreSQL 连接器 Lambda 的 `glue_connection` 环境变量设置为要使用的 Glue 连接的名称。

使用以下命令来获取 Glue 连接对象的架构。此架构包含可用于控制连接的所有参数。

```
aws glue describe-connection-type --connection-type POSTGRESQL
```

**Lambda 环境属性**

**glue\$1connection** – 指定与联合连接器关联的 Glue 连接的名称。

**注意**  
所有使用 Glue 连接的连接器都必须使用 AWS Secrets Manager 来存储凭证。
使用 Glue 连接创建的 PostgreSQL 连接器不支持使用多路复用处理程序。
使用 Glue 连接创建的 PostgreSQL 连接器仅支持 `ConnectionSchemaVersion` 2。

### 旧连接
<a name="connectors-postgresql-connection-legacy"></a>

下面列出的参数名称和定义适用于在没有关联 Glue 连接器时创建的 Athena 数据来源连接器。仅在[手动部署](connect-data-source-serverless-app-repo.md)早期版本的 Athena 数据来源连接器或未指定 `glue_connection` 环境属性时才使用以下参数。

#### 连接字符串
<a name="connectors-postgresql-connection-string"></a>

使用以下格式的 JDBC 连接字符串连接到数据库实例。

```
postgres://${jdbc_connection_string}
```

#### 使用多路复用处理程序
<a name="connectors-postgresql-using-a-multiplexing-handler"></a>

您可以使用多路复用器通过单个 Lambda 函数连接到多个数据库实例。按目录名称来路由请求。在 Lambda 中使用以下类。


****  

| 处理程序 | 类 | 
| --- | --- | 
| 复合处理程序 | PostGreSqlMuxCompositeHandler | 
| 元数据处理程序 | PostGreSqlMuxMetadataHandler | 
| 记录处理程序 | PostGreSqlMuxRecordHandler | 

##### 多路复用处理程序参数
<a name="connectors-postgresql-multiplexing-handler-parameters"></a>


****  

| 参数 | 说明 | 
| --- | --- | 
| \$1catalog\$1connection\$1string | 必需。数据库实例连接字符串。将 Athena 中使用的目录的名称作为环境变量前缀。例如，如果向 Athena 注册的目录是 mypostgrescatalog，则环境变量名称是 mypostgrescatalog\$1connection\$1string。 | 
| default | 必需。默认连接字符串。当目录为 lambda:\$1\$1AWS\$1LAMBDA\$1FUNCTION\$1NAME\$1 时使用此字符串。 | 

以下示例属性适用于支持两个数据库实例的 PostGreSql MUX Lambda 函数：`postgres1`（默认）和 `postgres2`。


****  

| 属性 | 值 | 
| --- | --- | 
| default | postgres://jdbc:postgresql://postgres1.host:5432/default?\$1\$1Test/RDS/PostGres1\$1 | 
| postgres\$1catalog1\$1connection\$1string | postgres://jdbc:postgresql://postgres1.host:5432/default?\$1\$1Test/RDS/PostGres1\$1 | 
| postgres\$1catalog2\$1connection\$1string | postgres://jdbc:postgresql://postgres2.host:5432/default?user=sample&password=sample | 

##### 提供凭证
<a name="connectors-postgresql-providing-credentials"></a>

要在 JDBC 连接字符串中为数据库提供用户名和密码，可以使用连接字符串属性或 AWS Secrets Manager。
+ **连接字符串** — 可以将用户名和密码指定为 JDBC 连接字符串中的属性。
**重要**  
作为安全最佳实践，请勿在环境变量或连接字符串中使用硬编码凭证。有关将硬编码密钥移至 AWS Secrets Manager 的信息，请参阅《*AWS Secrets Manager 用户指南*》中的[将硬编码密钥移至 AWS Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/hardcoded.html)。
+ **AWS Secrets Manager** - 要将 Athena 联合查询功能与 AWS Secrets Manager 配合使用，连接到您的 Lambda 函数的 VPC 应该拥有[互联网访问权限](https://aws.amazon.com/premiumsupport/knowledge-center/internet-access-lambda-function/)或者 [VPC 端点](https://docs.aws.amazon.com/secretsmanager/latest/userguide/vpc-endpoint-overview.html)，以连接到 Secrets Manager。

  您可以将 AWS Secrets Manager 中的密钥名称放入您的 JDBC 连接字符串中。连接器将该密钥名称替换为来自 Secrets Manager 的 `username` 和 `password` 值。

  对于 Amazon RDS 数据库实例，将紧密集成这种支持。如果您使用 Amazon RDS，我们强烈建议您使用 AWS Secrets Manager 和凭证轮换。如果您的数据库不使用 Amazon RDS，请按以下格式将凭证存储为 JSON：

  ```
  {"username": "${username}", "password": "${password}"}
  ```

**带有密钥名称的示例连接字符串**  
以下字符串带有密钥名称 `${Test/RDS/PostGres1}`。

```
postgres://jdbc:postgresql://postgres1.host:5432/default?...&${Test/RDS/PostGres1}&...
```

该连接器使用该密钥名称来检索秘密，并提供用户名和密码，如以下示例所示。

```
postgres://jdbc:postgresql://postgres1.host:5432/default?...&user=sample2&password=sample2&...
```

目前，PostgreSQL 连接器可以识别 `user` 和 `password` JDBC 属性。

##### 启用 SSL
<a name="connectors-postgresql-ssl"></a>

要在 PostgreSQL 连接中支持 SSL，请在连接字符串中附加以下内容：

```
&sslmode=verify-ca&sslfactory=org.postgresql.ssl.DefaultJavaSSLFactory
```

**示例**  
以下示例连接字符串不使用 SSL。

```
postgres://jdbc:postgresql://example-asdf-aurora-postgres-endpoint:5432/asdf?user=someuser&password=somepassword
```

要启用 SSL，如下所示修改字符串。

```
postgres://jdbc:postgresql://example-asdf-aurora-postgres-endpoint:5432/asdf?user=someuser&password=somepassword&sslmode=verify-ca&sslfactory=org.postgresql.ssl.DefaultJavaSSLFactory
```

#### 使用单个连接处理程序
<a name="connectors-postgresql-using-a-single-connection-handler"></a>

您可以使用以下单个连接元数据和记录处理程序连接到单个 PostgreSQL 实例。


****  

| 处理程序类型 | 类 | 
| --- | --- | 
| 复合处理程序 | PostGreSqlCompositeHandler | 
| 元数据处理程序 | PostGreSqlMetadataHandler | 
| 记录处理程序 | PostGreSqlRecordHandler | 

##### 单个连接处理程序参数
<a name="connectors-postgresql-single-connection-handler-parameters"></a>


****  

| 参数 | 说明 | 
| --- | --- | 
| default | 必需。默认连接字符串。 | 

单个连接处理程序支持一个数据库实例，并且必须提供 `default` 连接字符串参数。将忽略所有其他连接字符串。

以下示例属性适用于 Lambda 函数支持的单个 PostgreSQL 实例。


****  

| 属性 | 值 | 
| --- | --- | 
| default | postgres://jdbc:postgresql://postgres1.host:5432/default?secret=\$1\$1Test/RDS/PostgreSQL1\$1 | 

#### 溢出参数
<a name="connectors-postgresql-spill-parameters"></a>

Lambda 开发工具包可以将数据溢出到 Amazon S3。由同一 Lambda 函数访问的所有数据库实例都会溢出到同一位置。


****  

| 参数 | 说明 | 
| --- | --- | 
| spill\$1bucket | 必需。溢出桶名称。 | 
| spill\$1prefix | 必需。溢出桶密钥前缀。 | 
| spill\$1put\$1request\$1headers | （可选）用于溢出的 Amazon S3 putObject 请求的请求标头和值的 JSON 编码映射（例如，\$1"x-amz-server-side-encryption" : "AES256"\$1)。有关其他可能的标头，请参阅《Amazon Simple Storage Service API 参考》中的 [PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)。 | 

## 数据类型支持
<a name="connectors-postgresql-data-type-support"></a>

下表显示了适用于 JDBC、PostGreSQL 和 Arrow 的相应数据类型。


****  

| JDBC | PostGreSQL | Arrow | 
| --- | --- | --- | 
| 布尔值 | 布尔值 | Bit | 
| 整数 | 不适用 | Tiny | 
| 短型 | smallint | Smallint | 
| 整数 | 整数 | Int | 
| 长整型 | bigint | Bigint | 
| 浮点数 | float4 | Float4 | 
| 双精度 | float8 | Float8 | 
| 日期 | date | DateDay | 
| Timestamp | timestamp | DateMilli | 
| 字符串 | 文本 | Varchar | 
| 字节 | bytes | Varbinary | 
| BigDecimal | numeric(p,s) | 十进制 | 
| ARRAY | 不适用（见注释） | 列表 | 

**注意**  
PostgreSQL 连接器支持该 `ARRAY` 类型，但具有以下限制：不支持多维数组（`<data_type>[][]` 或嵌套数组）。包含不受支持的 `ARRAY` 数据类型的列将被转换为字符串元素数组 (`array<varchar>`)。

## 分区和拆分
<a name="connectors-postgresql-partitions-and-splits"></a>

分区用于确定如何为该连接器生成拆分。Athena 将构建一个 `varchar` 类型的合成列，它将展示表的分区方案，以帮助该连接器生成拆分。该连接器不会修改实际的表定义。

## 性能
<a name="connectors-postgresql-performance"></a>

PostgreSQL 支持本机分区。Athena PostgreSQL 连接器可从这些分区并行检索数据。如果您想查询具有统一分区分布的超大型数据集，强烈建议使用本机分区。

Athena PostgreSQL 连接器执行谓词下推，以减少查询扫描的数据量。`LIMIT` 子句、简单谓词和复杂表达式将下推到连接器，以减少扫描数据量并缩短查询执行的运行时间。但是，选择一部分列有时会导致查询执行的运行时间延长。

### LIMIT 子句
<a name="connectors-postgres-performance-limit-clauses"></a>

`LIMIT N` 语句用于减少查询扫描的数据量。`LIMIT N` 下推时，连接器仅向 Athena 返回 `N` 行。

### Predicates
<a name="connectors-postgres-performance-predicates"></a>

谓词是 SQL 查询的 `WHERE` 子句中的表达式，其评估结果为布尔值并根据多个条件筛选行。Athena PostgreSQL 连接器可以组合这些表达式并将其直接推送到 PostgreSQL，以增强功能并减少扫描的数据量。

以下 Athena PostgreSQL 连接器运算符支持谓词下推：
+ **布尔值：**AND、OR、NOT
+ **相等：**EQUAL、NOT\$1EQUAL、LESS\$1THAN、LESS\$1THAN\$1OR\$1EQUAL、GREATER\$1THAN、GREATER\$1THAN\$1OR\$1EQUAL、IS\$1DISTINCT\$1FROM、NULL\$1IF、IS\$1NULL
+ **算术：**ADD、SUBTRACT、MULTIPLY、DIVIDE、MODULUS、NEGATE
+ **其他：**LIKE\$1PATTERN、IN

### 组合下推示例
<a name="connectors-postgres-performance-pushdown-example"></a>

要增强查询功能，组合下推类型，如以下示例所示：

```
SELECT * 
FROM my_table 
WHERE col_a > 10 
    AND ((col_a + col_b) > (col_c % col_d))
    AND (col_e IN ('val1', 'val2', 'val3') OR col_f LIKE '%pattern%') 
LIMIT 10;
```

## 传递查询
<a name="connectors-postgres-passthrough-queries"></a>

PostgreSQL 连接器支持[传递查询](federated-query-passthrough.md)。传递查询使用表函数将完整查询下推到数据来源来执行查询。

要在 PostgreSQL 中执行传递查询，可以使用以下语法：

```
SELECT * FROM TABLE(
        system.query(
            query => 'query string'
        ))
```

以下示例查询将查询下推到 PostgreSQL 中的数据来源。该查询选择了 `customer` 表中的所有列，将结果限制为 10。

```
SELECT * FROM TABLE(
        system.query(
            query => 'SELECT * FROM customer LIMIT 10'
        ))
```

## 其他资源
<a name="connectors-postgresql-additional-resources"></a>

有关最新 JDBC 驱动程序版本信息，请参阅 GitHub.com 上适用于 PostgreSQL 连接器的 [pom.xml](https://github.com/awslabs/aws-athena-query-federation/blob/master/athena-postgresql/pom.xml) 文件。

有关此连接器的更多信息，请访问 GitHub.com 上的[相应站点](https://github.com/awslabs/aws-athena-query-federation/tree/master/athena-postgresql)。