Publish Events to PostgreSQL

MinIO AIStor supports publishing bucket notification events to PostgreSQL. MinIO AIStor supports PostgreSQL 9.5 and later only.

Prerequisites

PostgreSQL 9.5 and later

MinIO AIStor relies on features introduced with PostgreSQL 9.5.
The MinIO AIStor mc Command Line Tool

This procedure uses the mc command line tool for certain actions. See the mc Quickstart for installation instructions.

Add a PostgreSQL endpoint to an AIStor Server

The following procedure adds a new PostgreSQL service endpoint for supporting bucket notifications in an AIStor Server.

Add the PostgreSQL endpoint to MinIO AIStor.

You can configure a new PostgreSQL service endpoint using either environment variables or by setting runtime configuration settings.
MinIO AIStor supports specifying the PostgreSQL service endpoint and associated configuration settings using environment variables. The minio server process applies the specified settings on its next startup.
The minimum required variables are:
The following example code sets all environment variables related to configuring a PostgreSQL service endpoint.
export MINIO_NOTIFY_POSTGRES_ENABLE_<IDENTIFIER>="on" export MINIO_NOTIFY_POSTGRES_CONNECTION_STRING_<IDENTIFIER>="host=postgresql-endpoint.example.net port=5432" export MINIO_NOTIFY_POSTGRES_TABLE_<IDENTIFIER>="minioevents" export MINIO_NOTIFY_POSTGRES_FORMAT_<IDENTIFIER>="namespace" export MINIO_NOTIFY_POSTGRES_MAX_OPEN_CONNECTIONS_<IDENTIFIER>="2" export MINIO_NOTIFY_POSTGRES_QUEUE_DIR_<IDENTIFIER>="/opt/minio/events" export MINIO_NOTIFY_POSTGRES_QUEUE_LIMIT_<IDENTIFIER>="100000" export MINIO_NOTIFY_POSTGRES_COMMENT_<IDENTIFIER>="PostgreSQL Notification Event Logging for MinIO"
- Replace <IDENTIFIER> with a unique descriptive string for the PostgreSQL service endpoint. Use the same <IDENTIFIER> value for all environment variables related to the new target service endpoint. The following examples assume an identifier of primary.
  
  If the specified <IDENTIFIER> matches an existing PostgreSQL service endpoint on the AIStor Server, the new settings override any existing settings for that endpoint. Use mc admin config get notify_postgres to review the currently configured PostgreSQL endpoints on the AIStor Server.
- Replace <ENDPOINT> with the PostgreSQL Connection String for PostgreSQL service endpoint. MinIO AIStor supports key=value format for the connection string. For example:
  
  "host=postgresql.example.com port=5432 ..."
  
  For more complete documentation on supported PostgreSQL connection string parameters, see PostgreSQL Connection String.
See PostgreSQL Service for Bucket Notifications for complete documentation on each environment variable.
MinIO AIStor supports adding or updating PostgreSQL endpoints on a running minio server process using the mc admin config set command and the notify_postgres configuration key. MinIO AIStor applies a new or updated configuration setting immediately, with no server restart.
The minimum required settings are:
The following example code sets all settings related to configuring a PostgreSQL service endpoint.
mc admin config set ALIAS notify_postgres:IDENTIFIER \ connection_string="ENDPOINT" \ table="<string>" \ format="<string>" \ max_open_connections="<string>" \ queue_dir="<string>" \ queue_limit="<string>" \ comment="<string>"
- Replace IDENTIFIER with a unique descriptive string for the PostgreSQL service endpoint. The following examples in this procedure assume an identifier of primary.
  
  If the specified IDENTIFIER matches an existing PostgreSQL service endpoint on the AIStor Server, the new settings override any existing settings for that endpoint. Use mc admin config get notify_postgres to review the currently configured PostgreSQL endpoints on the AIStor Server.
- Replace <ENDPOINT> with the PostgreSQL connection string of the PostgreSQL service endpoint. MinIO AIStor supports key=value format for the PostgreSQL connection string. For example:
  
  "host=postgresql.example.com port=5432 ..."
  
  For more complete documentation on supported PostgreSQL connection string parameters, see PostgreSQL Connection String.
See PostgreSQL Bucket Notification Configuration Settings for complete documentation on each setting.
If you define both environment variables and configuration settings for the deployment, the settings defined by environment variables are used.
Confirm the target is registered.

MinIO AIStor applies a configuration setting change immediately.

If you configured this endpoint with environment variables, those values take precedence and mc admin config set has no effect on it. Update the environment variables on every node, then restart the deployment with the mc admin service restart command:
```
mc admin service restart ALIAS
```
Replace ALIAS with the alias of the deployment.

List the notification targets with mc event target list:
```
mc event target list ALIAS
```
The PostgreSQL target appears with an ARN similar to the following:
```
arn:minio:sqs::primary:postgresql
```
You must specify the ARN resource when configuring bucket notifications with the associated PostgreSQL deployment as a target.
Configure bucket notifications using the PostgreSQL endpoint as a target

Use the mc event add command to add a new bucket notification event with the configured PostgreSQL service as a target:
```
mc event add ALIAS/BUCKET arn:minio:sqs::primary:postgresql \
  --event EVENTS
```
- Replace ALIAS with the alias of an AIStor Server.
- Replace BUCKET with the name of the bucket in which to configure the event.
- Replace EVENTS with a comma-separated list of events for which MinIO AIStor triggers notifications.
Use mc event ls to view all configured bucket events for a given notification target:
```
mc event ls ALIAS/BUCKET arn:minio:sqs::primary:postgresql
```
Validate the configured events.

Perform an action on the bucket for which you configured the new event and check the PostgreSQL service for the notification data. The action required depends on which events were specified when configuring the bucket notification.

For example, if the bucket notification configuration includes the s3:ObjectCreated:Put event, you can use the mc cp command to create a new object in the bucket and trigger a notification.
```
mc cp ~/data/new-object.txt ALIAS/BUCKET
```

Update a PostgreSQL endpoint in an AIStor Server

The following procedure updates an existing PostgreSQL service endpoint for supporting bucket notifications in an AIStor Server.

List configured PostgreSQL endpoints in the deployment.

Use the mc admin config get command to list the currently configured PostgreSQL service endpoints in the deployment:
```
mc admin config get ALIAS notify_postgres
```
Replace ALIAS with the alias of the AIStor Server.

The command output resembles the following:
```
notify_postgres:primary queue_dir="" connection_string="postgresql://" queue_limit="0"  table="" format="namespace"
notify_postgres:secondary queue_dir="" connection_string="" queue_limit="0"  table="" format="namespace"
```
The notify_postgres key is the top-level configuration key for a PostgreSQL Notification Settings. The connection_string key specifies the PostgreSQL service endpoint for the given notify_postgres key. The notify_postgres:<IDENTIFIER> suffix describes the unique identifier for that PostgreSQL service endpoint.

Note the identifier for the PostgreSQL service endpoint you want to update for the next step.
Update the PostgreSQL endpoint.

Use the mc admin config set command to set the new configuration for the PostgreSQL service endpoint:
```
mc admin config set ALIAS notify_postgres:IDENTIFIER \
   connection_string="ENDPOINT" \
   table="<string>" \
   format="<string>" \
   max_open_connections="<string>" \
   queue_dir="<string>" \
   queue_limit="<string>" \
   comment="<string>"
```
The following configuration settings are the minimum required for a PostgreSQL service endpoint:
All other configuration settings are optional. See PostgreSQL Notification Settings for a complete list of PostgreSQL configuration settings.
Confirm the target is registered.

MinIO AIStor applies a configuration setting change immediately.

If you configured this endpoint with environment variables, those values take precedence and mc admin config set has no effect on it. Update the environment variables on every node, then restart the deployment with the mc admin service restart command:
```
mc admin service restart ALIAS
```
Replace ALIAS with the alias of the deployment.

List the notification targets with mc event target list:
```
mc event target list ALIAS
```
The PostgreSQL target appears with an ARN similar to the following:
```
arn:minio:sqs::primary:postgresql
```
Validate the changes.

Perform an action on a bucket which has an event configuration using the updated PostgreSQL service endpoint and check the PostgreSQL service for the notification data. The action required depends on which events were specified when configuring the bucket notification.

For example, if the bucket notification configuration includes the s3:ObjectCreated:Put event, you can use the mc cp command to create a new object in the bucket and trigger a notification.
```
mc cp ~/data/new-object.txt ALIAS/BUCKET
```

Publish Events to PostgreSQL

Prerequisites

Add a PostgreSQL endpoint to an AIStor Server

Update a PostgreSQL endpoint in an AIStor Server

On this page