Schemas
PhpStorm displays databases and schemas that you selected to be displayed in the Database tool window. It can be useful if you have many databases and schemas. Also, by using this approach, you define which schemas you want to introspect. During introspection, PhpStorm loads the metadata from the database and uses this data later.
Schemas can be seen in the Database tool window. You can see a reference on node and object icons in the Data sources and their elements chapter of Database tool window topic.
Create a schema
In the Database tool window ( ) , expand the data source tree until the nodes of databases or schemas.
Right-click the data source, database, or schema node and select .
In the Modify dialog that opens, enter the name of your schema in the Name field.
In the Preview pane, you can view and change the generated SQL code.
Click OK.
Select the default schema
You can select the default schema or database by using the list, which is in the upper-right part of the toolbar. When you select the default schema, you can omit the name of that schema or database in your statements.
Click the <schema> list and select the schema that you need.
Set the default schema in connection settings
Open data source properties. You can open data source properties by using one of the following options:
In the Database tool window ( ) , click the Data Source Properties icon
.Press Shift+Enter.
Select a data source that you want to modify. On the General tab in the Database field, type the name of a schema that you want to use as default.
Show and hide schemas and databases
In the Database tool window ( ) , right-click a data source and navigate to . Select or clear checkboxes of schemas that you want to enable or disable. Press Enter.
Click the N of M link near the data source name. In the database and schema selection window, select or clear checkboxes of databases and schemas that you want to enable or disable. Press Enter.
Pattern-based schemas filter
To display and introspect all the schemas or databases with names that match a regular expression pattern, do the following:
In the Database tool window ( ) , click the N of M link near the data source name.
In the databases and schemas selector, click the add pattern button.
In the new filtering node, define the regular expression. Press Enter to apply the filter in the selector.
Press Enter to apply the filter.
The filtering node with filter can be added under any node, including another filtering node.
Show all the schemas and databases
To display all the available databases and schemas in the Database tool window ( ), click the Show Options Menu button and select the All Namespaces option.
Disabled
Enabled
Compare two schemas
For more information about dialog controls, refer to Controls of the Migration dialog.
Select two schemas.
Right-click the selection and navigate to . Alternatively, press Ctrl+D.
Set the schema search path for PostgreSQL and Redshift
The search_path environment variable in PostgreSQL specifies the order in which schemas are searched. For example, you set the value of search_path to z,a,public, PostgreSQL will look for a value in the z schema. If nothing was not found in the z schema, PostgreSQL looks for the value in the a schema.
In PostgreSQL and Amazon Redshift, the default search path (the path that is set in a database) is used unless you specify a different search path.
Click the <session> list, navigate to the list of database schemas (use the arrow icon
or press the right arrow key).Select the schema that you want to add to a search path.
To form a search path, you can use the following actions:
Press Space to add a highlighted schema to the search path and to remove a schema from the search path.
Press Alt+Up and Alt+Down to reorder the schemas within the search path.
To apply the changes, click OK.
Save a search path for PostgreSQL and Redshift between IDE restarts
In the Database tool window ( ) , right-click a PostgreSQL or Amazon Redshift data source and select Properties Shift+Enter.
Click the Options tab.
From the Switch schema list, select Automatic.
Click OK.
Force refresh schema information
The Force Refresh action clears the data source information from cache and loads it again from scratch.
In the Database tool window ( ) , right-click a data source and select .
Pre-introspected objects from system catalogs
Introspection is a method of inspecting a data source. When you perform introspection, structural information in the data source is inspected to detect tables, columns, functions, and other elements with their attributes.
A system catalog is a place where a relational database management system (DBMS) stores information about tables and columns, built-in functions, and other schema objects. The IDE uses these objects for code completion and other coding assistance operations.
System schemas have the lightning icon (
) in the schema selection dialog. If you do not select these schemas, PhpStorm does not introspect them and does not show them in the Database tool window. Though information about schema objects is used in coding assistance. It is possible because PhpStorm uses internal data about schema objects that was introspected earlier (pre-introspected data). To enable usage of pre-introspected data in PhpStorm, open data source settings by pressing Shift+Enter, click the Options tab and select Use pre-introspected objects for system catalogs that are not introspected.
Examples of system catalogs in different DBMS:
PostgreSQL: pg_catalog, information_schema
Microsoft SQL Server: INFORMATION_SCHEMA
Oracle: SYS, SYSTEM
MySQL: information_schema
IBM Db2 LUW: SYSCAT, SYSFUN, SYSIBM, SYSIBMADM, SYSPROC, SYSPUBLIC, SYSSTAT, SYSTOOLS
Introspect system catalogs for a data source
By default, PhpStorm uses pre-introspected objects for system catalogs.
In the Database tool window ( ) , right-click a data source and select Properties Ctrl+Alt+S.
In the Data Sources and Drivers dialog, click the Options tab.
Clear the Use pre-introspected objects for system catalogs that are not introspected checkbox.
In the scheme selection window, select system catalogs that you want to introspect.
Use pre-introspected data for the selected system catalog
You can still use pre-introspected objects for a system catalog even if you disable the usage of such objects for a data source.
Clear the Use pre-introspected objects for system catalogs that are not introspected checkbox on the Options tab in data source settings.
Open the scheme selection window, clear the checkbox of a system catalog.
Click the system catalog entry.
Click the lightning icon
, which is in the upper-right corner of the window.
Generate a diagram for a schema
In the Database tool window ( ) , right-click a schema and select .
