Schema Explorer
Schema Explorer is a panel on the Write Query screen. Use it to browse NetSuite records, fields, and joins, then click to insert names into the editor without leaving NimbusQL.
It uses the same records catalog that powers autocomplete.
Opening Schema Explorer
Section titled “Opening Schema Explorer”- Open the Write Query screen
- Click Schema
The Schema Explorer panel opens beside the editor. Click Schema again, or the close control on the panel, to hide it.
If you leave the panel open, it stays open the next time you visit Write Query in this browser.
Schema Explorer is not available when you are running a Report. Executing a query also closes the panel so there is more room for results.
Autocomplete
Section titled “Autocomplete”Autocomplete uses the same records catalog as Schema Explorer. In the editor, press Ctrl + Space to open suggestions.
- After
FROM, or after an unqualified word, suggestions are table names - After a table or alias and a period (
currency.orc.), suggestions are fields for that table - Exact name matches appear first, the same way Schema Explorer ranks search results
- Click a suggestion to insert it at the cursor
If you used an alias (for example FROM currency c), completing after c. offers that table’s fields as c.id, c.name, and so on.
Only fields that can be queried in this account are offered.
Opening Schema Explorer from Autocomplete
Section titled “Opening Schema Explorer from Autocomplete”Table suggestions include a book icon. Click the icon to open Schema Explorer on that record: the panel opens if it was closed, search is set to the record, and the record is expanded.
When you complete fields after a period, the first row in the list is the table itself, such as currency or currency (alias c). Choosing that row opens Schema Explorer for the table instead of inserting text.
Finding a Record
Section titled “Finding a Record”Type in Search records… to filter the list. Exact name matches appear first.
If nothing matches, the panel shows No matching records.
The first time the catalog loads, you may see Loading records catalog…
Expanding a Record
Section titled “Expanding a Record”Click the arrow next to a record name to show its fields and joins. The first expand may take a moment (Loading fields…).
Click the arrow again to collapse the list.
Fields
Section titled “Fields”Each field shows its SuiteQL name, data type, and label when the label is different.
- Click the field name to insert that name into the editor
- Click the plus control to insert
table.field
When a record has many fields, a Filter fields… box appears so you can narrow the list.
The Joins list shows related records.
- Click a join name to jump to that record in the tree
- Click the plus control to insert the related table name
Inserting Into the Editor
Section titled “Inserting Into the Editor”Inserted text is added at the cursor. If you have text selected, that selection is replaced.
On each record row (hover to see the actions):
- Click the record name to insert the table name
- Click the code icon to insert a starter
SELECTfor that record - Click the folder icon to open the record in NetSuite’s Records Catalog
The starter SELECT uses the first available fields (up to 25). Fields that are not queryable in this account are left out so the generated query can run.
Rebuilding the Schema Cache
Section titled “Rebuilding the Schema Cache”If the catalog looks out of date after you add custom records or fields, click Rebuild schema cache.
Rebuild reads every record and field from NetSuite again and updates the shared cache for the account. Autocomplete and Schema Explorer both use that cache. It can take a few minutes. Progress appears under the button, such as Rebuilding… 120 of 800 records.
Administrators can also set how long the catalog is kept before it rebuilds automatically. See Settings.
- Schema Explorer and autocomplete share the same records catalog.
- Open and closed state is remembered in this browser only.
- Reports do not show Schema Explorer.