CODEWITHSUNDEEP
javascriptpostgresqlpg-promisenode-postgres
Emmanuel Campos
Emmanuel Campos

Reputation: 726

How to set schema in pg-promise

I was searching the documentation of pg-promise specifically in the creation of the client. But I wasn't able to find the option to set the default schema to be used in the connection, it always uses public schema. How do I set it?

Upvotes: 2

Views: 5207

Answers (1)

vitaly-t
vitaly-t

Reputation: 25860

Normally, one sets the default schema(s) for the database or the role, as explained here:

It is only if you want to do so without persisting the change, you might want to set the schema(s) dynamically, just for the current process.

The library supports option schema within Initialization Options:

const initOptions = {
    schema: 'my_schema' /* can also be an array of strings or a callback */
};

const pgp = require('pg-promise')(initOptions);

making it easier to set the dynamic schema(s).

Examples

  • Making your own schema visible along with the default public schema:

    const initOptions = {
    schema: ['public', 'my_schema'] /* make both schemas visible */
};

const pgp = require('pg-promise')(initOptions);

  • Using the callback to set schema based on the Database Context (see Database constructor):

    const initOptions = {
    schema(dc) {
        if(dc === /* whatever Database Context was used */) {
            return 'my_schema'; /* or an array of strings */
        }
        /* other provisions, if multiple databases are used. */

        /* can return null/undefined, if no schema change is needed. */
    }
};

const pgp = require('pg-promise')(initOptions);

Upvotes: 8

Related Questions