Name Resolution

A query can specify a table name without a database or schema name (e.g., SELECT * FROM orders). How does CockroachDB know which orders table is being considered and in which schema?

This page details how CockroachDB performs name resolution to answer this question.

Logical schemas and namespaces

A CockroachDB cluster can store multiple databases, and each database can store multiple tables/views/sequences. This two-level structure for stored data is commonly called the "logical schema" in relational database management systems.

Meanwhile, CockroachDB aims to provide compatibility with PostgreSQLclient applications and thus supports PostgreSQL's semantics for SQLqueries. To achieve this, CockroachDB supports a three-levelstructure for names. This is called the "naming hierarchy".

In the naming hierarchy, the path to a stored object has three components:

  • database name (also called "catalog")
  • schema name
  • object name
    The schema name for all stored objects in any given database is alwayspublic. There is only a single schema available for storedobjects because CockroachDB only supports a two-level storagestructure.

In addition to public, CockroachDB also supports a fixed set ofvirtual schemas, available in every database, that provide ancillary, non-storeddata to client applications. For example,information_schema is provided forcompatibility with the SQL standard.

The list of all databases can be obtained with SHOW
DATABASES. The list of all schemas for a givendatabase can be obtained with SHOW SCHEMAS. Thelist of all objects for a given schema can be obtained with otherSHOW statements.

How name resolution works

Name resolution occurs separately to look up existing objects and todecide the full name of a new object.

The rules to look up an existing object are as follows:

  • If the name already fully specifies the database and schema, use that information.
  • If the name has a single component prefix, try to find a schema with the prefix name in the current database. If that fails, try to find the object in the public schema of a database with the prefix name.

  • If the name has no prefix, use the search path with the current database.
    Similarly, the rules to decide the full name of a new object are as follows:

  • If the name already fully specifies the database and schema, use that.

  • If the name has a single component prefix, try to find a schema with that name. If no such schema exists, use the public schema in the database with the prefix name.
  • If the name has no prefix, use the current schema in the current database.

Parameters for name resolution

Current database

The current database is used when a name is unqualified or has only one component prefix. It is the current value of the database session variable.

  • You can view the current value of the database session variable with SHOW
    database     and change it with SET database.

  • You can inspect the list of valid database names that can be specified in database with SHOW DATABASES.

  • For client apps that connect to CockroachDB using a URL of the form postgres://…, the initial value of the database session variable can be set using the path component of the URL. For example, postgres://node/mydb sets database to mydb when the connection is established.

Search path

The search path is used when a name is unqualified (has no prefix). It lists the schemas where objects are looked up. Its first element is also the current schema where new objects are created.

  • You can set the current search path with SET search_path and inspected it with SHOW
    search_path    .

  • You can inspect the list of valid schemas that can be listed in search_path with SHOW SCHEMAS.

  • By default, the search path contains public and pg_catalog. For compatibility with PostgreSQL, pg_catalog is forced to be present in search_path at all times, even when not specified withSET search_path.

Current schema

The current schema is used as target schema when creating a new object if the name is unqualified (has no prefix).

  • The current schema is always the first value of search_path, for compatibility with PostgreSQL.

  • You can inspect the current schema using the special built-in function/identifier current_schema().

Index name resolution

CockroachDB supports the following ways to specify an index name for statements that require one (e.g., DROP INDEX, ALTER INDEX … RENAME, etc.):

  • Index names are resolved relative to a table name using the @ character, e.g., DROP INDEX tbl@idx;. This is the default and most common syntax.
  • Index names are resolved by searching all tables in the current schema to find a table with an index named idx, e.g., DROP INDEX idx; or (with optional schema prefix) DROP INDEX public.idx;. This syntax is necessary for Postgres compatibility because Postgres index names live in the schema namespace such that e.g., public.idx will resolve to the index idx of some table in the public schema. This capability is used by some ORMs.
    The name resolution algorithm for index names supports both partial and complete qualification, using the same name resolution rules as other objects.

Examples

The examples below use the following logical schema as a starting point:

  1. > CREATE DATABASE mydb;
  1. > CREATE TABLE mydb.mytable(x INT);
  1. > SET database = mydb;

Lookup with unqualified names

An unqualified name is a name with no prefix, that is, a simple identifier.

  1. > SELECT * FROM mytable;

This uses the search path over the current database. The search pathis public by default, in the current database. The resolved name ismydb.public.mytable.

  1. > SET database = system;
  1. > SELECT * FROM mytable;
  1. pq: relation "mytable" does not exist

This uses the search path over the current database, which is nowsystem. No schema in the search path contain table mytable, so thelook up fails with an error.

Lookup with fully qualified names

A fully qualified name is a name with two prefix components, that is,three identifiers separated by periods.

  1. > SELECT * FROM mydb.public.mytable;

Both the database and schema components are specified. The lookupsucceeds if and only if the object exists at that specific location.

Lookup with partially qualified names

A partially qualified name is a name with one prefix component, that is, two identifiers separated by a period. When a name is partially qualified, CockroachDB will try to use the prefix as a schema name first; and if that fails, use it as a database name.

For example:

  1. > SELECT * FROM public.mytable;

This looks up mytable in the public schema of the currentdatabase. If the current database is mydb, the lookup succeeds.

For compatibility with CockroachDB 1.x, and to ease development inmulti-database scenarios, CockroachDB also allows queries to specifya database name in a partially qualified name. For example:

  1. > SELECT * FROM mydb.mytable;

In that case, CockroachDB will first attempt to find a schema calledmydb in the current database. When no such schema exists (which isthe case with the starting point in this section), it then tries tofind a database called mydb and uses the public schema in that. Inthis example, this rule applies and the fully resolved name ismydb.public.mytable.

Using the search path to use tables across schemas

Suppose that a client frequently accesses a stored table as well as a virtual table in the Information Schema. Because information_schema is not in the search path by default, all queries that need to access it must mention it explicitly.

For example:

  1. > SELECT * FROM mydb.information_schema.schemata; -- valid
  1. > SELECT * FROM information_schema.schemata; -- valid; uses mydb implicitly
  1. > SELECT * FROM schemata; -- invalid; information_schema not in search_path

For clients that use information_schema often, you can add it to thesearch path to simplify queries. For example:

  1. > SET search_path = public, information_schema;
  1. > SELECT * FROM schemata; -- now valid, uses search_path

Databases with special names

When resolving a partially qualified name with just one componentprefix, CockroachDB will look up a schema with the given prefix namefirst, and only look up a database with that name if the schema lookupfails. This matters in the (likely uncommon) case where you wish yourdatabase to be called information_schema, public, pg_catalogor crdb_internal.

For example:

  1. > CREATE DATABASE public;
  1. > SET database = mydb;
  1. > CREATE TABLE public.mypublictable (x INT);

The CREATE TABLE statement in this example uses a partiallyqualified name. Because the public prefix designates a valid schemain the current database, the full name of mypublictable becomesmydb.public.mypublictable. The table is created in database mydb.

To create the table in database public, one would instead use afully qualified name, as follows:

  1. > CREATE DATABASE public;
  1. > CREATE TABLE public.public.mypublictable (x INT);

See also

Was this page helpful?
YesNo