Install PostGIS for AlloyDB Omni

AlloyDB Omni does not include the PostGIS extension, but you can manually add it to an existing AlloyDB Omni installation by following the instructions on this page to add support for storing, indexing, and querying geospatial data.

Before you begin

Ensure that you've installed AlloyDB Omni on your system.

Single-server

Add PostGIS to your AlloyDB Omni installation

To add the PostGIS extension to your AlloyDB Omni installation, follow these steps:

Find your installed AlloyDB Omni version labels:
```
docker run --rm -it  google/alloydbomni cat VERSION.txt
```
The output is similar to the following:
```
AlloyDB Omni version: 15.5.3
```
Take note of the AlloyDB Omni version number; you need it in the next step.
Set the OMNI_VERSION environment variable:
```
OMNI_VERSION=VERSION
```
Replace VERSION with the complete database server version from the previous step—for example, 15.5.3.

Create a new AlloyDB Omni container that includes PostGIS:

Linux

   mkdir ~/alloydb-omni-postgis
   tee -a ~/alloydb-omni-postgis/Dockerfile << EOF
   ARG OMNI_VERSION
   FROM postgres:15-bookworm as postgres

   RUN apt-get update && \
         apt-get install -y --no-install-recommends \
         postgresql-15-postgis-3 && \
         apt-get purge -y --auto-remove && \
         rm -rf /var/lib/apt/lists/*

   FROM google/alloydbomni:${OMNI_VERSION}

   COPY --from=postgres /usr/lib/postgresql/15/lib/postgis-3.so /usr/lib/postgresql/15/lib/postgis-3.so
   COPY --from=postgres /usr/lib/postgresql/15/lib/postgis_sfcgal-3.so /usr/lib/postgresql/15/lib/postgis_sfcgal-3.so
   COPY --from=postgres /usr/lib/postgresql/15/lib/postgis_raster-3.so /usr/lib/postgresql/15/lib/postgis_raster-3.so
   COPY --from=postgres /usr/lib/postgresql/15/lib/postgis_topology-3.so /usr/lib/postgresql/15/lib/postgis_topology-3.so
   COPY --from=postgres /usr/lib/postgresql/15/lib/address_standardizer-3.so /usr/lib/postgresql/15/lib/address_standardizer-3.so
   COPY --from=postgres /usr/share/postgresql/15/extension/address_standardizer* /usr/lib/postgresql/15/share/extension/
   COPY --from=postgres /usr/share/postgresql/15/extension/postgis* /usr/lib/postgresql/15/share/extension/

   COPY --from=postgres /usr/lib/x86_64-linux-gnu/ /usr/lib/x86_64-linux-gnu/
   COPY --from=postgres /lib/x86_64-linux-gnu/ /lib/x86_64-linux-gnu/

   COPY --from=postgres /usr/lib/x86_64-linux-gnu/liblapack.so.3 /usr/lib/
   COPY --from=postgres /usr/lib/x86_64-linux-gnu/libblas.so.3 /usr/lib/
   COPY --from=postgres /usr/lib/libarmadillo.so.11 /usr/lib/
   COPY --from=postgres /usr/lib/libmfhdfalt.so.0 /usr/lib/
   COPY --from=postgres /usr/lib/libmfhdfalt.so.0 /usr/lib/
   COPY --from=postgres /usr/lib/libdfalt.so.0 /usr/lib/
   COPY --from=postgres /usr/lib/libogdi.so.4.1 /usr/lib/
   COPY --from=postgres /usr/share/proj/proj.db /usr/share/proj/proj.db

   EOF
cd ~/alloydb-omni-postgis
sudo docker build --build-arg OMNI_VERSION=$OMNI_VERSION --tag google/alloydbomni-with-postgis:$OMNI_VERSION .

macOS

   mkdir ~/alloydb-omni-postgis
   tee -a ~/alloydb-omni-postgis/Dockerfile << EOF
   ARG OMNI_VERSION
   FROM postgres:15-bookworm as postgres

   RUN apt-get update && \
         apt-get install -y --no-install-recommends \
         postgresql-15-postgis-3 && \
         apt-get purge -y --auto-remove && \
         rm -rf /var/lib/apt/lists/*

   FROM google/alloydbomni:${OMNI_VERSION}

   COPY --from=postgres /usr/lib/postgresql/15/lib/postgis-3.so /usr/lib/postgresql/15/lib/postgis-3.so
   COPY --from=postgres /usr/lib/postgresql/15/lib/postgis_sfcgal-3.so /usr/lib/postgresql/15/lib/postgis_sfcgal-3.so
   COPY --from=postgres /usr/lib/postgresql/15/lib/postgis_raster-3.so /usr/lib/postgresql/15/lib/postgis_raster-3.so
   COPY --from=postgres /usr/lib/postgresql/15/lib/postgis_topology-3.so /usr/lib/postgresql/15/lib/postgis_topology-3.so
   COPY --from=postgres /usr/lib/postgresql/15/lib/address_standardizer-3.so /usr/lib/postgresql/15/lib/address_standardizer-3.so
   COPY --from=postgres /usr/share/postgresql/15/extension/address_standardizer* /usr/lib/postgresql/15/share/extension/
   COPY --from=postgres /usr/share/postgresql/15/extension/postgis* /usr/lib/postgresql/15/share/extension/

   COPY --from=postgres /usr/lib/aarch64-linux-gnu/ /usr/lib/aarch64-linux-gnu/
   COPY --from=postgres /lib/aarch64-linux-gnu/ /lib/aarch64-linux-gnu/

   COPY --from=postgres /usr/lib/aarch64-linux-gnu/liblapack.so.3 /usr/lib/
   COPY --from=postgres /usr/lib/aarch64-linux-gnu/libblas.so.3 /usr/lib/
   COPY --from=postgres /usr/lib/libarmadillo.so.11 /usr/lib/
   COPY --from=postgres /usr/lib/libmfhdfalt.so.0 /usr/lib/
   COPY --from=postgres /usr/lib/libmfhdfalt.so.0 /usr/lib/
   COPY --from=postgres /usr/lib/libdfalt.so.0 /usr/lib/
   COPY --from=postgres /usr/lib/libogdi.so.4.1 /usr/lib/
   COPY --from=postgres /usr/share/proj/proj.db /usr/share/proj/proj.db

   EOF
cd ~/alloydb-omni-postgis
sudo docker build --build-arg OMNI_VERSION=$OMNI_VERSION --tag google/alloydbomni-with-postgis:$OMNI_VERSION .

Create a new container with AlloyDB Omni named my-omni-postgis:

docker run --name my-omni-postgis  -e POSTGRES_PASSWORD=NEW_PASSWORD  -d google/alloydbomni-with-postgis:OMNI_VERSION

Connect to your database with the PostGIS extension:

docker exec -it my-omni-postgis psql -h localhost -U postgres

Enable PostGIS:

CREATE EXTENSION IF NOT EXISTS POSTGIS;

SELECT postgis_full_version();

The output looks similar to the following:

postgis_full_version
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
POSTGIS="3.4.2 c19ce56" [EXTENSION] PGSQL="150" GEOS="3.11.1-CAPI-1.17.1" PROJ="9.1.1 NETWORK_ENABLED=OFF URL_ENDPOINT= USER_WRITABLE_DIRECTORY=/var/lib/postgresql/.local/share/proj DATABASE_PATH=/usr/share/proj/proj.db" LIBXML="2.9.14" LIBJSON="0.16" LIBPROTOBUF="1.4.1" WAGYU="0.5.0 (Internal)"
(1 row)