Server

Server#

Represents an endpoint that hosts any number of databases. You connect to a server using a driver, which tells SQL Current which Python driver / adapter library to use.

A server has a host property which can be referenced in a database connection string property (connString, serverConnString). A server also has its own connString property for performing server operations that do not apply to any database.

A server can contain any number of databases. You use the server Statement to define a server.

For more information, see the following:

Creating#

In a SQL Current context, creating a server means initializing the server for use. You would normally “create” a server before creating databases in the server.

To create a server, you use the create property to specify one or more server create scripts. Then you create the server using the create server Statement or the create servers Statement.

server my_server
{
        driver: 'postgres';
        connString: 'postgresql://postgres:postgres@127.0.0.1';
        create: './create.sql';
}

create server my_server; // Runs the create.sql script, which might create users, roles, logins, databases, etc.

For more information see the following:

Checking#

You can run check scripts against a server to make sure the server is in the correct state. This can be very helpful to ensure your server create scripts were successful, and to detect changes or misconfigurations later.

server my_server
{
        driver: 'postgres';
        connString: 'postgresql://postgres:postgres@127.0.0.1';
        create: './create.sql';
        check: './check.sql';
}

check server my_server;

For more information see the following:

Resetting#

Resetting a server puts the server into a pre-create state. It effectively “undoes” whatever the create scripts do. If you follow this practice, you should be able to run a reset server, then a create server statement against the same server without errors.

To reset a server, you use the reset property to specify one or more server reset scripts. Then you reset the server using the reset server or the reset servers.

server my_server
{
        driver: 'postgres';
        connString: 'postgresql://postgres:postgres@127.0.0.1';
        create: './create.sql';
        reset: './reset.sql';
}

reset server my_server;

For more information see the following:

Recreating#

Recreating a server is a reset followed by a create.

The following script:

recreate server my_server;

is shorthand for, and will do the exact same thing as this script:

reset server my_server;
create server my_server;

See Also#

Contents