This page describes how to run and connect to AlloyDB Omni after you install it on your own machine .
Before you begin
Most of the commands on this page use the AlloyDB Omni CLI.
To install this command-line tool on your machine, see Install the AlloyDB Omni CLI .
Run AlloyDB Omni
The procedures you use to run AlloyDB Omni depend on whether you're running AlloyDB Omni in a container on a single server.
Installing AlloyDB Omni sets up a system service called alloydb-dataplane
that's configured to launch every time that your machine
boots.
For basic control and monitoring of AlloyDB Omni, use the sudo alloydb
command, as demonstrated in the following sections.
Start AlloyDB Omni
sudo
alloydb
database-server
start
To perform a test connection, see Connect using the containerized psql
.
Check the status of AlloyDB Omni
sudo
alloydb
database-server
status
Stop AlloyDB Omni
sudo
alloydb
database-server
stop
Disable startup launch
Running the following command prevents AlloyDB Omni from automatically starting when your machine boots.
sudo
systemctl
disable
alloydb-dataplane
Re-enable startup launch
sudo
systemctl
enable
alloydb-dataplane
Connect to AlloyDB Omni running on a single server
The AlloyDB Omni container includes its own copy of psql
that lets
you open an interactive SQL shell session with its database server.
You can also connect to AlloyDB Omni from outside the container, using the PostgreSQL-compatible software of your choice.
Connect using the containerized psql
To connect to the AlloyDB Omni database server using its own
containerized copy of psql
, run the following command:
Single-server
docker
exec
-it
pg-service
psql
-h
localhost
-U
postgres
This command connects you to the server as the postgres
user role, and displays
a postgres=#
command prompt. You can now run psql
commands
and SQL
queries.
To exit psql
, run the \q
command.
Connect using your own applications
Any application that works with PostgreSQL can also work with AlloyDB Omni, with no modification needed.
To connect to the AlloyDB Omni database server, use any
PostgreSQL-compatible client or code library to connect to port 5432
—the
default PostgreSQL database server port—of the machine running
AlloyDB Omni.
This works because the AlloyDB Omni container exposes its own port 5432
to the same port of the machine that it runs on.
After connecting to the database server, you can define, query, and modify your databases using DML and SQL queries by using standard PostgreSQL communication protocols.
Because AlloyDB Omni runs within your own environment, you can control how you connect to AlloyDB Omni. This includes allowing or restricting network access to this service according to the needs of your application, just as you would with an ordinary PostgreSQL server.
