PremiumSoft Premium, for MySQL, for Oracle, for PostgreSQL, for SQLite, for SQL Server Navicat User Manual

Managing Table Comment

Table SQL Preview

Navicat Win 131

MySQL Table Fields

Table fields are managed on the Fields tab of the Table Designer. Just simply click a field for editing. A right-click displays the popup menu or using field toolbar, allowing you to create new, insert, move and drop the selected field.

Add Field

To add a field to the table



Open the table in the Table Designer.

Open the Fields tab.

Right-click and select the Add Field from the popup menu or click the Add Field from the toolbar.

Edit field properties.

To add a new field with modification as one of the existing fields



Open the table in the Table Designer.

Open the Fields tab.

Select field.

Right-click and select the Duplicate Field from the popup menu.

Edit field properties.

Insert Field

To insert a field above an existing field



Open the table in the Table Designer.

Open the Fields tab.

Select field.

Right-click and select the Insert Field from the popup menu or click the Insert

Field from the toolbar.

Define field properties in the empty row.

Note: Support from MySQL 3.22 or later.

Navicat Win 132

Edit Field

To edit the table field



Open the table in the Table Designer.

Open the Fields tab.

Simply click on the field to edit.

To change the order of the table fields



Open the table in the Table Designer.

Open the Fields tab.

Right-click on the field to move and select the Move Up/ Move Down from the popup menu or click the Move Up/ Move Down from the toolbar.

Note: Support from MySQL 4.0.1 or later.

Delete Field

To delete the table field



Open the table in the Table Designer.

Open the Fields tab.

Right-click on the field to delete and select the Delete Field from the popup menu or click the Delete Field from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 133

Setting MySQL Table Field Properties

Name

The Name is a descriptive identifier for a field that can be up to 64 characters (letters or numbers) including spaces. The names should be descriptive enough that anyone can easily identify them when viewing or editing records. For example, LastName, FirstName,

StreetAddress, or HomePhone.

Use the Name edit box to set the field name. Note that the name of the field must be unique among all the field names in the table.

Type

After you name a field, you choose a data type for the data to be contained in the field. When you choose a field's data type, you are deciding:



 What kind of values to allow in the field. You cannot store text in field with the

Numeric data type.

How much storage space MySQL is to set aside for the data in that field.

What types of operations can be performed on the values in that field.

The Type dropdown list defines the type of the field data. See MySQL Data Types for details.

Length and Decimals

Use the Length edit box to define the length of the field and use Decimals edit box to define the number of digits after the decimal point (the scale) for Floating Point data type.

Note: Be careful when shortening the field length as losing data might be caused.

Allow Null

Allow the NULL values for the field.

Navicat Win 134

Primary Key

A Primary Key is a single field or combination of fields that uniquely defines a record. None of the fields that are part of the primary key can contain a null value.

Navicat Win 135

Setting MySQL Table Other Field Properties

To set the default value for the field use the Default edit box.

Note: TEXT(tinytext, text, mediumtext and longtext) and BLOB(tinyblob, blob, mediumblob and longblob) data type cannot have DEFAULT values.

To set any optional text describing the current field use the Comment edit box.

Note: Apply to all data type.

To set other field properties for Text/Memo and BLOB (Binary Large Object) (not apply to binary/varbinary type)

Character set (non-binary strings only)

A character set is a set of symbols and encodings. The Character set drop-down list defines the type of the character set for field.

Collation (non-binary strings only)

A collation is a set of rules for comparing characters in a character set. The Collation drop-down list defines the type of the collation for field.

Note: MySQL chooses the column character set and collation in the following manner: o o o

If both CHARACTER SET X and COLLATE Y were specified, then character set X and collation Y are used.

If CHARACTER SET X was specified without COLLATE, then character set

X and its default collation are used.

Otherwise, the table character set and collation are used.

Key Length

The edit box will be enabled when Primary Key is set. KEY LENGTH (1 - 255).

Binary (char and varchar only)

As of MySQL 4.1, values in CHAR and VARCHAR fields are sorted and compared according to the collation of the character set assigned to the field.

Navicat Win 136

Before MySQL 4.1, sorting and comparison are based on the collation of the server character set; you can declare the field with the BINARY attribute to cause sorting and comparison to be based on the numeric values of the bytes in field values. BINARY does not affect how field values are stored or retrieved.

To set other field properties for Number/Currency and Floating Point (not apply to bit type)

Auto Increment (Number/Currency only)

The AUTO INCREMENT attribute can be used to generate a unique identity for new rows.

To start with the AUTO INCREMENT value other than 1, you can set that value in Options tab.

Unsigned

UNSIGNED values can be used when you want to allow only non-negative numbers in a field and you need a bigger upper numeric range for the field.

As of MySQL 4.0.2, floating-point and fixed-point types also can be UNSIGNED. Unlike the integer types, the upper range of column values remains the same.

Zerofill

The default padding of spaces is replaced with zeros. For example, for a field declared as

INT(5) ZEROFILL, a value of 4 is retrieved as 00004; for a field declared as FLOAT(20,10)

ZEROFILL, a value of 0.1 is retrieved as 000000000.1000000015.

Note: If you specify ZEROFILL for a numeric type, MySQL automatically adds the

UNSIGNED attribute to the field.

To set other field properties for Date/Time

On Update Current_Timestamp (timestamp only)

As of 4.1.2, you have more flexibility in deciding which TIMESTAMP field automatically is initialized and updated to the current timestamp.

To set other field properties for Set/Enumerate

Values

Use Values edit box to define the members of SET/ENUM. A SET field can have a maximum of 64 members. An ENUM field can have a maximum of 65,535 distinct values.

Navicat Win 137

MySQL Table Indexes

Indexes are organized versions of specific columns in your tables. MySQL uses indexes to facilitate quick retrieval of records. With indexes, MySQL can jump directly to the records you want. Without any indexes, MySQL has to read the entire data file to find the correct record(s).

Table indexes are managed on the Indexes tab of the Table Designer. Just simply click/double-click an index field for editing. A right-click displays the popup menu or using the index toolbar, allowing you to create new, edit and delete the selected index field.

Add Index

To add a table index



Open the table in the Table Designer.

Open the Indexes tab.

Right-click and select the Add Index from the popup menu or click the Add

Index from the toolbar.

Edit index properties.

Edit Index

To edit a table index



Open the table in the Table Designer.

Open the Indexes tab.

Just simply click/double-click on the index to edit.

Delete Index

To delete a table index



Open the table in the Table Designer.

Open the Indexes tab.

Right-click on the index to delete and select the Delete Index from the popup menu or click the Delete Index from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 138

Setting MySQL Table Index Properties

Use the Name edit box to set the index name.

To include field(s) in the index, just simply double-click the Fields field or click to open the editor for editing.

Select the field(s) from the list. To remove the fields from the index, uncheck them in the same way. You can also use the arrow buttons to change the index field(s) order. The Sub

Part edit box(s) is used to set index KEY LENGTH (1 - 255).

Note: Some of data types do not allow indexing by several fields. For example: BLOB

The Index Type dropdown list defines the type of the table index.

Normal

NORMAL indexes are the most basic indexes, and have no restraints such as uniqueness.

Unique

UNIQUE indexes are the same as NORMAL indexes with one difference - all values of the indexed column(s) must only occur once.

Full Text

FULL TEXT indexes are used by MySQL in full-text searches.

Navicat Win 139

Index method

Specify an index type when creating an index, BTREE or HASH.

Navicat Win 140

MySQL Table Foreign Keys

A foreign key is a field in a relational table that matches the primary key column of another table. The foreign key can be used to cross-reference tables.

Foreign Keys are managed on the Foreign Keys tab of the Table Designer. Just simply click/double-click a foreign key field for editing. A right-click displays the popup menu or using the foreign key toolbar, allowing you to create new, edit and delete the selected foreign key field.

Note: Foreign Key support from MySQL 3.23.44 or later.

Add Foreign Key

To add a foreign key



Open the table in the Table Designer.

Open the Foreign Keys tab.

Right-click and select the Add Foreign Key from the popup menu or click the

Add Foreign Key from the toolbar.

Edit foreign key properties.

Note: Both tables must be InnoDB type (or solidDB type if you have solidDB for

MySQL ). In the referencing table, there must be an index where the foreign key columns are listed as the first columns in the same order. Starting with MySQL 4.1.2, such an index will be created on the referencing table automatically if it does not exist.

Edit Foreign Key

To edit a foreign key



Open the table in the Table Designer.

Open the Foreign Keys tab.

Just simply click/double-click on the foreign key to edit.

Note: Support from MySQL 4.0.13 or later.

Navicat Win 141

Delete Foreign Key

To delete a foreign key



Open the table in the Table Designer.

Open the Foreign Keys tab.

Right-click on the foreign key to delete and select the Delete Foreign Key from the popup menu or click the Delete Foreign Key from the toolbar.

Confirm deleting in the dialog window.

Note: Support from MySQL 4.0.13 or later.

Navicat Win 142

Setting MySQL Table Foreign Key Properties

Use the Name edit box to enter a name for the new key and then select a table field to include in the key from the Fields group.

Use the Reference Database and Reference Table dropdown lists to select a foreign database and table respectively.

To include field(s) to the key, just simply double-click the Fields/Reference Fields field or click to open the editor(s) for editing.

The On Delete and On Update dropdown list define the type of the actions to be taken.

CASCADE

Delete the corresponding foreign key, or update the corresponding foreign key to the new value of the primary key.

SET NULL

Set all the columns of the corresponding foreign key to NULL.

No ACTION

Does not change the foreign key.

RESTRICT

Produce an error indicating that the deletion or update would create a foreign key constraint violation.

Navicat Win 143

MySQL Table Triggers

A trigger is a named database object that is associated with a table and that is activated when a particular event occurs for the table.

Triggers are managed on the Triggers tab of the Table Designer. Just simply click a trigger field for editing. A right-click displays the popup menu or using the trigger toolbar, allowing you to create new, edit and delete the selected trigger field.

Note: Trigger is supported from MySQL 5.0.2 or later.

Add Trigger

To add a trigger



Open the table in the Table Designer.

Open the Triggers tab.

Right-click and select the Add Trigger from the popup menu or click the Add

Trigger from the toolbar.

Edit trigger properties.

Edit Trigger

To edit a trigger



Open the table in the Table Designer.

Open the Triggers tab.

Just simply click on the trigger to edit.

Delete Trigger

To delete a trigger



Open the table in the Table Designer.

Open the Triggers tab.

Right-click on the trigger to delete and select the Delete Trigger from the popup menu or click the Delete Trigger from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 144

Setting MySQL Table Trigger Properties

Use the Name edit box to set the trigger name.

Use the Fires dropdown list to define the trigger action time. It can be Before or After to indicate that the trigger activates before or after the statement that activated it.

Insert

The trigger is activated whenever a new row is inserted into the table. For example, INSERT,

LOAD DATA, and REPLACE statements.

Update

The trigger is activated whenever a row is modified. For example, UPDATE statement.

Delete

The trigger is activated whenever a row is deleted from the table. For example, DELETE and

REPLACE statement. However, DROP TABLE and TRUNCATE statements on the table do not activate the trigger.

The Definition tab defines the statement to execute when the trigger activates. To include your statement, just simply click to write. If you want to execute multiple statements, use the BEGIN ... END compound statement construct.

Example:

BEGIN

set new.capacity = new.capcity + 100;

set new.amount = new.amount + 100;

END

Navicat Win 145

MySQL Table Options

Engine

Define the engine of the table.

Character set

Define the type of the character set for table.

Collation

Choose the collation for the table.

Auto Increment

Set/Reset the Auto Increment value in the edit field. The Auto Increment Value indicates the value for next record.

Checksum

Check this option if you want MySQL to maintain a live checksum for all rows.

Note: Support MyISAM only.

Row Format

Defines how the rows should be stored.

Avg. Row Length

An approximation of the average row length for your table. You need to set this only for large tables with variable-size rows.

Max Rows

The maximum number of rows you plan to store in the table. This is not a hard limit, but rather a hint to the storage engine that the table must be able to store at least this many rows.

Min Rows

The minimum number of rows you plan to store in the table.

Key Block Size

This option provides a hint to the storage engine about the size in bytes to use for index key blocks. The engine is allowed to change the value if necessary. A value of 0 indicates that the default value should be used.

Navicat Win 146

Pack Keys

Set this option to 1 if you want to have smaller indexes. This usually makes updates slower and reads faster. Setting the option to 0 disables all packing of keys. Setting it to DEFAULT tells the storage engine to pack only long CHAR, VARCHAR, BINARY, or VARBINARY columns.

Note: Takes effect only with MyISAM tables.

Delay Key Write

Check this option if you want to delay key updates for the table until the table is closed.

Note: Support MyISAM only.

Data Directory

To specify where the MyISAM storage engine should put a table's data file.

Index Directory

To specify where the MyISAM storage engine should put a table's index file.

Partition

Set the Partition Options.

Note: Support from MySQL 5.1 or later.

MRG_MYISAM table type

Union

UNION is used when you want to access a collection of identical MyISAM tables as one.

This works only with MERGE tables. You must have SELECT, UPDATE, and DELETE privileges for the tables you map to a MERGE table.

Insert Method

If you want to insert data into a MERGE table, you must specify with INSERT_METHOD the table into which the row should be inserted. INSERT_METHOD is an option useful for MERGE tables only. Use a value of FIRST or LAST to have inserts go to the first or last table, or a value of NO to prevent inserts.

Navicat Win 147

FEDERATED table type

Connection

To create the local table that will be federated to the remote table. You can create the local table and specify the connection string (containing the server name, login, password) to be used to connect to the remote table using the Connection edit box.

The CONNECTION string contains the information required to connect to the remote server containing the table that will be used to physically store the data. The connection string specifies the server name, login credentials, port number and database/table information.

The format the connection string is as follows: scheme://user_name[:password]@host_name[:port_num]/db_name/tbl_name

Sample of connection strings:

CONNECTION='mysql://username:password@hostname:port/database/tablename'

CONNECTION='mysql://username@hostname/database/tablename'

CONNECTION='mysql://username:password@hostname/database/tablename'

ndbcluster table type

Tablespace

To specify the tablespace for the storage.

Note: Support from MySQL 5.1.6 or later.

Storage

To specify type of storage used (disk or memory), and can be one of DISK, MEMORY, or DEFAULT.

Note: Support from MySQL 5.1.6 or later.

Navicat Win 148

Setting MySQL Table Partition Options

Partition By

Select the function that is used to determine the partition: HASH, KEY, LINEAR HASH,

LINEAR KEY, RANGE and LIST.

Partitions

Set the partition number.

Subpartition By

Select the function that is used to determine the subpartition: Hash and Key.

Subpartitions

Set the subpartition number.

Partition Definition

Use or Partition to add or delete the partition. Use or Subpartition to add or delete the subpartition.

Values

For range partitioning, each partition must include a VALUES LESS THAN clause; for list partitioning, you must specify a VALUES IN clause for each partition. This is used to determine which rows are to be stored in this partition.

Engine

Select the storage engine for both partition and subpartition.

Data Directory

The directory where the data for this partition are to be stored.

Index Directory

The directory where the indexes for this partition are to be stored.

Max Rows

The maximum number of rows to be stored in the partition.

Min Rows

The minimum number of rows to be stored in the partition.

Navicat Win 149

Tablespace

Designate a tablespace for the partition. Used for Falcon only.

Node Group

Set the Node Group.

Comment

Enter the comment for the partition.

Navicat Win 150

MySQL Views

Views (including updatable views) are implemented in MySQL Server 5.0 and available in binary releases from 5.0.1 and up. Views are useful for allowing users to access a set of relations (tables) as if it were a single table, and limiting their access to just that. Views can also be used to restrict access to rows (a subset of a particular table). For access control to columns, you can also use the sophisticated privilege system in MySQL Server.

Just simply click to open an object pane for View. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit, open and delete the selected view.

Create View

To create a new view



Select anywhere on the object pane.

Click the New View from the object pane toolbar. or

Right-click and select New View from the popup menu.

Edit view properties on the appropriate tabs of the View Designer.

Hint: To create new view you can also right-click the Views node of the navigation pane and select the New View from the popup menu.

To create a new view with the same properties as one of the existing views has (using drag and drop method)

Apply to: current database {same connection}



Select the view(s) for copying in the navigation pane/object pane.

Right-click and drag the chosen view(s) to the target location.

Select one of the following options: o

Copy here (Structure and Data) o o

Copy here (Structure only)

Move here o

Cancel

The newly created view(s) will be named as "viewname_copy".

Navicat Win 151

Apply to: different database {same connection} different database {different connection} ( Data Transfer tool will be activated)



Select the view(s) for copying in the object pane.

Drag and drop the chosen view(s) to the target database.

Select one of the following options: o o o

Copy here (Structure and Data)

Copy here (Structure only)

Cancel

To create a new view with modification as one of the existing views



Select the view for modifying in the navigation pane/object pane.

Right-click and select the Design View from the popup menu. or

Click the Design View from the object pane toolbar.

Modify view properties on the appropriate tabs of the View Designer.

Click Save As.

To create a new view with loading from a SQL file



Select anywhere on the object pane.

Click the New View from the object pane toolbar. or

Right-click and select New View from the popup menu.

Click Load.

Create View Shortcut

To create a view shortcut



Select the view for editing in the navigation pane/object pane.

Right-click and select Create Open View Shortcut... from the popup menu.

Define the location you wish your shortcut to be saved.

Note: This option is used to provide a convenient way for you to open your view for entering data directly ( Grid View/Form View ) without activating the main Navicat.

Navicat Win 152

Edit View

To edit the existing view (manage its SQL definition etc)



Select the view for editing in the navigation pane/object pane.

Right-click and select the Design View from the popup menu. or

Click the Design View from the object pane toolbar.

Edit view properties on the appropriate tabs of the View Designer.

To change the name of the view



Select the view for editing in the navigation pane/object pane.

Right-click and select the Rename from the popup menu.

Open View

To open a view (manage view data)



Select the view for opening in the navigation pane/object pane.

Right-click and select the Open View from the popup menu or simply double-click the view. or

Click the Open View from the object pane toolbar.

Delete View

To delete a view



Select the view for deleting in the navigation pane/object pane.

Right-click and select the Delete View from the popup menu. or

Click the Delete View from the object pane toolbar.

Confirm deleting in the dialog window.

Navicat Win 153

Achieve View Information

To achieve a view information



Select the view in the navigation pane/object pane.

Right-click the selected view and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 154

MySQL View Designer

View Designer is the basic Navicat tool for working with views. It allows you to create new view and edit the existing view definition (view name and the SELECT statement it implements).



View SQL Preview

Setting Parameters for Procedure/Function

Navicat Win 155

Working with MySQL View Builder (Available only in Full Version)

View Builder allows you to build views visually. It allows you to create and edit views without knowledge of SQL. See Query Builder for details.

Navicat Win 156

Editing MySQL View SQL Definition

The Definition tab allows you to edit the view definition as SQL statement (SELECT statement it implements).

Example:

SELECT

clients.RecordID

FROM

clients

Hint: To customize the view of the editor and find out more features for sql editing, see Editor

View and More Features .

Navicat Win 157

Setting Advanced MySQL View Properties

Algorithm

Algorithm is optional and it is a MySQL extension to standard SQL. Algorithm takes three values: Undefined, Merge or Temptable. The default algorithm is Undefined if no

Algorithm clause is present. The algorithm affects how MySQL processes the view.

Undefined

For Undefined, MySQL chooses which algorithm to use. It prefers Merge over

Temptable if possible, because Merge is usually more efficient and because a view cannot be updatable if a temporary table is used.

Merge

For Merge, the text of a statement that refers to the view and the view definition are merged such that parts of the view definition replace corresponding parts of the statement.

Temptable

For Temptable, the results from the view are retrieved into a temporary table, which then is used to execute the statement.

Definer

The default Definer value is the user who executes the CREATE VIEW statement. (This is the same as DEFINER = CURRENT_USER.) If a user value is given, it should be a MySQL account in 'user_name'@'host_name' format (the same format used in the GRANT statement). The user_name and host_name values both are required.

Security

The SQL SECURITY characteristic determines which MySQL account to use when checking access privileges for the view when the view is executed. The legal characteristic values are

Definer and Invoker. These indicate that the view must be executable by the user who defined it or invoked it, respectively. The default Security value is Definer.

Navicat Win 158

Check option

The Check option can be given for an updatable view to prevent inserts or updates to rows except those for which the WHERE clause in the select_statement is true. The Local and

Cascaded keywords determine the scope of check testing when the view is defined in terms of another view. Local restricts the Check option only to the view being defined. Cascaded causes the checks for underlying views to be evaluated as well. When neither keyword is given, the default is Cascaded.

Navicat Win 159

MySQL View Preview

To preview the result of the view, click Preview on the toolbar. If the query statement is correct, the Result and Message tabs will be opened.

The Result tab displays the data of the view as a grid and the Message tab displays the message log.

Navicat Win 160

MySQL View Explain

To show the Query Plan of the view, click Explain on the toolbar. If the query statement is correct, the Explain tab will show the query plan.

Navicat Win 161

MySQL View Viewer

View Viewer displays the view data as a grid. Data can be displayed in three modes:

Grid View, Form View and Text/Blob View. See Data View for details.

The toolbars of View Viewer provides the following functions for managing data:

 Export Data

Export data to MS Word, MS Excel, MS Access, TXT, DBF, HTML, SQL, RTF and more.

 Filter Data

Allow you to filter records by creating and applying filter criteria for the data grid.

 Edit TEXT/BLOB

Allow you to view and edit the content of TEXT and BLOB fields.

Navicat Win 162

MySQL Functions/Procedures

Stored routines (procedures and functions) are supported in MySQL 5.0. A stored routine is a set of SQL statements that can be stored in the server. Once this has been done, clients do not need to keep reissuing the individual statements but can refer to the stored routine instead.

Just simply click to open an object pane for Function. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected function/procedure.

Create Function/Procedure

To create a new function/procedure



Select anywhere on the object pane.

Click the New Function from the object pane toolbar. or

Right-click and select New Function from the popup menu.

Edit function/procedure properties on the appropriate tabs of the Function/Procedure

Designer.

Hint: To create new function/procedure you can also right-click the Function node of the navigation pane and select the New Function from the popup menu.

To create a new function/procedure with the same properties as one of the existing function/procedure has (using drag and drop method)

Apply to: current database {same connection}



Select the function/procedure(s) for copying in the navigation pane/object pane.

Right-click and drag the chosen function/procedure(s) to the target location.

Select one of the following options: o o

Copy here (Structure and Data)

Copy here (Structure only) o o

Move here

Cancel

The newly created function/procedure(s) will be named as

"function/procedurename_copy".

Navicat Win 163

Apply to: different database {same connection} different database {different connection} ( Data Transfer tool will be activated)



Select the function/procedure(s) for copying in the object pane.

Drag and drop the chosen function/procedure(s) to the target database.

Select one of the following options: o o o

Copy here (Structure and Data)

Copy here (Structure only)

Cancel

To create a new function/procedure with modification as one of the existing function/procedure



Select the function/procedure for modifying in the navigation pane/object pane.

Right-click and select the Design Function from the popup menu or simply double-click the function/procedure. or

Click the Design Function from the object pane toolbar.

Modify function/procedure properties on the appropriate tabs of the

Function/Procedure Designer.

Click Save As.

Edit Function/Procedure

To edit the existing function/procedure (manage its definition etc)



Select the function/procedure for editing in the navigation pane/object pane.

Right-click and select the Design Function from the popup menu or simply double-click the function/procedure. or

Click the Design Function from the object pane toolbar.

Edit function/procedure properties on the appropriate tabs of the Function/Procedure

Designer.

To change the name of the function/procedure



Select the function/procedure for editing in the navigation pane/object pane.

Right-click and select the Rename from the popup menu.

Navicat Win 164

Run Function/Procedure

To run a function/procedure in the navigation pane/object pane



Select the function/procedure for executing in the navigation pane/object pane.

Click the Execute Function from the object pane toolbar. or

Right-click and select Execute Function from the popup menu.

View/edit the returned data on the Result tab.

To run a function/procedure in the Function/Procedure Designer



Create a new function/procedure/open the existing function/procedure.

Click Run.

View/edit the returned data on the Result tab.

Delete Function/Procedure

To delete a function/procedure



Select the function/procedure for deleting in the navigation pane/object pane.

Right-click and select the Delete Function from the popup menu. or

Click the Delete Function from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Function/Procedure Information

To achieve a function/procedure information



Select the function/procedure in the navigation pane/object pane.

Right-click the selected function/procedure and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 165

MySQL Function Wizard

Click the New Function from the object pane toolbar. The Function Wizard will pop up and it allows you to create a procedure/function easily.



Setting Routine Type

Editing Function/Procedure Definition

You are allowed not to show the Function Wizard when create new procedure/function.

Hint: Once uncheck the Show wizard next time, you can go to Options to enable it.

Navicat Win 166

Setting MySQL Routine Type

Select the type of the routine: Procedure or Function

Navicat Win 167

Setting Parameters for MySQL Procedure/Function

Procedure

Define the parameter(s) of the procedure. Set the parameter Mode, Name and Type under corresponding columns.

Function

Define the parameter(s) of the function. Set the parameter Name and Type under corresponding columns.

Navicat Win 168

Setting Return Type for MySQL Function

Select the Return Type from the list and enter the corresponding information: Length,

Decimals, Character Set and/or Enum.

Note: Only function supports return type.

Navicat Win 169

MySQL Function/Procedure Designer

Function/Procedure Designer is the basic Navicat tool for working with functions/procedures. It allows you to create new function/procedure and edit the existing function/procedure definition.



Setting Advanced Function/Procedure Properties

Editing Function/Procedure Comment

Function/Procedure SQL Preview

Viewing Function/Procedure Result

Navicat Win 170

Editing MySQL Function/Procedure Definition

Edit the function/procedure definition under the Definition tab. Definition consists of a valid

SQL procedure statement. This can be a simple statement such as SELECT or INSERT, or it can be a compound statement written using BEGIN and END. Compound statements can contain declarations, loops, and other control structure statements.

Example:

BEGIN

RETURN CONCAT('Hello', name1, ' and ',name2, '!');

END

Hint: To customize the view of the editor and find out more features for sql editing, see Editor

View and More Features .

Parameter

Define function/procedure parameter.

Return Type

This text box will be enabled only for creating a function. It indicates the return type of the function.

Type

Select the stored routines you wish to create from the drop-down list, i.e. PROCEDURE and

FUNCTION.

Navicat Win 171

Setting Advanced MySQL Function/Procedure Properties

Security

The SQL SECURITY characteristic can be used to specify whether the routine should be executed using the permissions of the user who creates the routine or the user who invokes it. The default value is Definer.

Definer

The default Definer value is the user who executes the CREATE PROCEDURE or CREATE

FUNCTION statement. (This is the same as DEFINER = CURRENT_USER.) If a user value is given, it should be a MySQL account in 'user_name'@'host_name' format (the same format used in the GRANT statement). The user_name and host_name values both are required.

Data Access

Several characteristics provide information about the nature of data use by the routine.

Contains SQL

Indicates that the routine does not contain statements that read or write data. It is the default if none of these characteristics is given explicitly.

No SQL

Indicates that the routine contains no SQL statements.

Reads SQL Data

Indicates that the routine contains statements that read data, but not statements that write data.

Modifies SQL Data

Indicates that the routine contains statements that may write data.

Deterministic

A procedure or function is considered deterministic if it always produces the same result for the same input parameters, and not deterministic otherwise. The default is not deterministic.

Navicat Win 172

Viewing MySQL Function/Procedure Result

To run the procedure/function click Run on the toolbar. If the SQL statement is correct, the statement will be executed and, if the statement is supposed to return data, the Result tab opens with the data returned by the procedure/function. If an error occurs while executing the procedure/function, execution stops, the appropriate error message is displayed.

If the function/procedure requires input parameter, the Input Parameters box will popup.

Note: The Result tab displays the result data as grid.

Hint: Navicat supports to return 10 resultsets.

Navicat Win 173

MySQL Events

MySQL Event Scheduler was added in MySQL 5.1.6. MySQL Events are tasks that run according to a schedule. Therefore, we sometimes refer to them as scheduled events. When you create an event, you are creating a named database object containing one or more SQL statements to be executed at one or more regular intervals, beginning and ending at a specific date and time. Conceptually, this is similar to the idea of the Windows Task

Scheduler.

Just simply click to open an object pane for Event. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected event.

Create Event

To create a new event



Select anywhere on the object pane.

Click the New Event from the object pane toolbar. or

Right-click and select New Event from the popup menu.

Edit event properties on the appropriate tabs of the Event Designer.

Hint: To create new event you can also right-click the Event node of the navigation pane and select the New Event from the popup menu.

To create a new event with the same properties as one of the existing event has (using drag and drop method)

Apply to: current database {same connection}



Select the event(s) for copying in the navigation pane/object pane.

Right-click and drag the chosen event(s) to the target location.

Select one of the following options: o

Copy here (Structure and Data) o o

Copy here (Structure only)

Move here o

Cancel

The newly created event(s) will be named as "eventname_copy".

Navicat Win 174

Apply to: different database {same connection} different database {different connection} ( Data Transfer tool will be activated)



Select the event(s) for copying in the object pane.

Drag and drop the chosen event(s) to the target database.

Select one of the following options: o o o

Copy here (Structure and Data)

Copy here (Structure only)

Cancel

To create a new event with modification as one of the existing event



Select the event for modifying in the navigation pane/object pane.

Right-click and select the Design Event from the popup menu or simply double-click the event. or

Click the Design Event from the object pane toolbar.

Modify event properties on the appropriate tabs of the Event Designer.

Click Save As.

Edit Event

To edit the existing event (manage its definition etc)



Select the event for editing in the navigation pane/object pane.

Right-click and select the Design Event from the popup menu or simply double-click the event. or

Click the Design Event from the object pane toolbar.

Edit event properties on the appropriate tabs of the Event Designer.

To change the name of the event



Select the event for editing in the navigation pane/object pane.

Right-click and select the Rename from the popup menu.

Navicat Win 175

Delete Event

To delete an event



Select the event for deleting in the navigation pane/object pane.

Right-click and select the Delete Event from the popup menu. or

Click the Delete Event from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Event Information

To achieve an event information



Select the event in the navigation pane/object pane.

Right-click the selected event and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 176

MySQL Event Designer

Event Designer is the basic Navicat tool for working with events. It allows you to create new event and edit the existing event definition.



Editing Event Definition

Setting Advanced Event Properties

Editing Event Comment

Event SQL Preview

Navicat Win 177

Editing MySQL Event Definition

Edit the event definition under the Definition tab. Definition consists of a valid SQL statement. This can be a simple statement such as SELECT or INSERT, or it can be a compound statement written using BEGIN and END. Compound statements can contain declarations, loops, and other control structure statements.

Hint: To customize the view of the editor and find out more features for sql editing, see Editor

View and More Features .

Definer

Specifies the user account to be used when checking access privileges at event execution time. The default DEFINER value is the user who executes the CREATE EVENT statement.

(This is the same as DEFINER = CURRENT_USER.) If a user value is given, it should be a

MySQL account in 'user_name'@'host_name' format (the same format used in the GRANT statement). The user_name and host_name values both are required.

STATUS

You can create an event but keep it from being active using the DISABLE keyword.

Alternatively, you may use ENABLE to make explicit the default status, which is active.

ON COMPLETION

Normally, once an event has expired, it is immediately dropped. You can override this behavior by specifying ON COMPLETION PRESERVE. Using ON COMPLETION NOT PRESERVE merely makes the default non-persistent behavior explicit.

Navicat Win 178

Setting Advanced MySQL Event Properties

Edit the ON SCHEDULE clause under Schedule tab. The ON SCHEDULE clause determines when, how often, and for how long the SQL statement defined for the event repeats. This clause takes one of two forms:

AT timestamp is used for a one-time event. It specifies that the event executes one time only at the date and time, given as the timestamp, which must include both the date and time, or must be an expression that resolves to a datetime value.

Use +INTERVAL to create an event which occurs at some point in the future relative to the current date and time.

EVERY

For actions which are to be repeated at a regular interval, you can use an EVERY clause which followed by an interval. (+INTERVAL is not used with EVERY.)

STARTS

An EVERY clause may also contain an optional STARTS clause. STARTS is followed by a

timestamp value which indicates when the action should begin repeating, and may also use +INTERVAL interval in order to specify an amount of time "from now".

For example: EVERY 3 MONTH STARTS CURRENT_TIMESTAMP + 1 WEEK means "every three months, beginning one week from now".

ENDS

An EVERY clause may also contain an optional ENDS clause. The ENDS keyword is followed by a timestamp value which tells MySQL when the event should stop repeating.

You may also use +INTERVAL interval with ENDS.

Navicat Win 179

For Instance: EVERY 12 HOUR STARTS CURRENT_TIMESTAMP + INTERVAL

30 MINUTE ENDS CURRENT_TIMESTAMP + INTERVAL 4 WEEK is equivalent to "every twelve hours, beginning thirty minutes from now, and ending four weeks from now".

P.S.

The timestamp must be in the future - you cannot schedule an event to take place in the past.

The interval portion consists of two parts, a quantity and a

*unit of time.

WEEK | SECOND | YEAR_MONTH | DAY_HOUR |

DAY_MINUTE |

DAY_SECOND | HOUR_MINUTE | HOUR_SECOND |

MINUTE_SECOND

Navicat Win 180

Oracle Database Object Management

The following list contains the most common Oracle database objects supported by Navicat.

Hint: Oracle interprets non-quoted object identifiers as uppercase. In Navicat, all objects identifier will be quoted. That is, Navicat saves exactly what you have inputted.



Materialized View Logs

Public Database Links

Public Synonyms

Navicat Win 181

Oracle Debugger (Available only in Full Version)

Navicat provides Oracle PL/SQL debugger for debugging Oracle functions, procedures, packages and queries.



Code Window

Views

Oracle Debugger Toolbar

Navicat Win 182

Oracle Debugger Code Window

The Code Window shows the code of the procedure/function. You can add/remove breakpoints for debugging by clicking in the grey area beside each statement.

To add a variable to the watch list, simply right-click the highlighted code and choose Add to

watch list.

To show the debug tips, simply mouse-over the code.

Navicat Win 183

Oracle Debugger Views

Under menu View, you can choose to show/hide the following view windows.

You can choose View -> Default Layout to restore the Layout to the default one.



Navicat Win 184

Repositioning Oracle Debugger Views

To re-arrange the workspace items, click on any pane in the workspace, then hold down your cursor and drag the pane to the desired area, and release the cursor. The selected pane will appear in its new position.

Hint: As you drag a pane to its new position, a Pane Sticker will appear and a bright blue indicator will mark the insertion point.

Navicat Win 185

Oracle Debugger Breakpoints

The Breakpoints view displays all the breakpoints which allowing you to delete, enable or disable breakpoints.

To enable/disable a breakpoint, simply check/uncheck the check box.

Also, you can delete a breakpoint or all breakpoints, simply right-click a breakpoint and choose Remove Breakpoint or Remove All Breakpoints.

To jump to the line of a breakpoint, right-click it and choose Goto Function.

Navicat Win 186

Oracle Debugger Call Stack

The Call Stack view displays the procedure or function calls of the current line.

To jump to a procedure or function, right-click it and choose Goto Function.

Navicat Win 187

Oracle Debugger DBMS Output

The DBMS Output view displays the results after the function or procedure has completed the execution.

Navicat Win 188

Oracle Debugger Log

The Log view shows the message log when debugging the code.

Navicat Win 189

Oracle Debugger Smart Data

The Smart Data view displays information about the variables associated with breakpoints.

To add a variable to the watch list, simply right-click a variable and choose Add to watch

list.

You can adjust the value of a watch variable by simply right-click the variable and choose

Adjust Value.

Navicat Win 190

Oracle Debugger Watch List

The Watch List view displays information about the variables being watched, allowing you to add, delete or edit watch variables.

To add a watch variable, simply right-click anywhere of Watch List view and choose Add

Variable. Then, enter the Variable Name. Also, you can right-click the highlighted code in the Code Window or the variable in the Smart Data view and choose Add to watch list.

You can adjust the value of a watch variable by right-click the variable and choose Adjust

Value.

To delete a watch variable or all watch variables, simply right-click a variable and choose

Remove Variable or Remove All Variable.

Navicat Win 191

Oracle Debugger Toolbar

You can perform the most commonly used actions for debugging on the toolbar or menu:

Run

Start running code in debug mode by clicking Run or pressing F9. The debugger executes your code until the end of the code or the next breakpoint is reached.

Step Over

While execution of your code is paused, you can resume it by clicking Step Over or pressing F8. Then, the current line will be executed. If the line is a procedure or function call, it will bypass the procedure or function. The counter will then move to the next line of code.

Step In

While execution of your code is paused, you can resume it by clicking Step In or pressing

F7. Then, it executes the current line. If the line is a procedure or function call, the counter goes to the first statement in the procedure or function. Otherwise, the counter will move to the next line of code.

Step Out

While execution of your code is paused, you can resume it by clicking Step Out or pressing Shift+F7. Then, the remaining part of the code within the current procedure or function will be executed. Subsequently, the counter will jump to the line which is just after the caller of the method.

Step End

While execution of your code is paused, you can resume it by clicking Step End. Then, the counter will jump to the last line of the procedure or function.

Stop

While execution of your code is paused, you can stop stepping the code by clicking Stop.

Then, the execution will stop and cannot resume it.

Navicat Win 192

Editing Oracle Physical Attributes/Default Storage Characteristics

% Free

Specify a whole number representing the percentage of space in each data block of the database object reserved for future updates to rows of the object. The value must be from 0 to 99. A value of 0 means that the entire block can be filled by inserts of new rows. The default value is 10.

% Used

Specify a whole number representing the minimum percentage of used space that Oracle maintains for each data block of the database object. A block becomes a candidate for row insertion when its used space falls below this value. The value must be from 0 to 99 and defaults to 40.

Initial Transactions

Specify the initial number of concurrent transaction entries allocated within each data block allocated to the database object. This value can range from 1 to 255 and defaults to 1.

Note: The default value for an index is 2.

Maximum Transactions

Specify the maximum number of concurrent update transactions allowed for each data block in the segment.

Storage

Initial

Specify the size of the first extent of the object. Use the dropdown list K, M, G, T, P or E to specify the size in kilobytes, megabytes, gigabytes, terabytes, petabytes, or exabytes. If you do not specify any of the abbreviations, then the size is interpreted as bytes.

Next

Specify the size of the next extent to be allocated to the object. Use the dropdown list K, M,

G, T, P or E to specify the size in kilobytes, megabytes, gigabytes, terabytes, petabytes, or exabytes. If you do not specify any of the abbreviations, then the size is interpreted as bytes.

Min Extents

Specify the total number of extents to allocate when the object is created.

Navicat Win 193

Max Extents

Specify the total number of extents, including the first, that Oracle can allocate for the object.

Check Unlimited if you want extents to be allocated automatically as needed.

Max Size

Specify the maximum size of the storage element. Use the dropdown list K, M, G, T, P or E to specify the size in kilobytes, megabytes, gigabytes, terabytes, petabytes, or exabytes. If you do not specify any of the abbreviations, then the size is interpreted as bytes. Check

Unlimited if you do not want to limit the disk space of the storage element.

% Increase

Specify the percent by which the third and subsequent extents grow over the preceding extent. The default value is 50.

Freelists

For objects other than tablespaces and rollback segments, specify the number of free lists for each of the free list groups for the table, partition, cluster, or index.

Freelist Group

Specify the number of groups of free lists for the database object you are creating. The default and minimum value for this parameter is 1.

Optimal

Specify an optimal size for a rollback segment. Use the dropdown list K, M, G, T, P or E to specify the size in kilobytes, megabytes, gigabytes, terabytes, petabytes, or exabytes. If you do not specify any of the abbreviations, then the size is interpreted as bytes. Check Null for no optimal size for the rollback segment.

Buffer Pool

DEFAULT

Choose this to indicate the default buffer pool. This is the default for objects not assigned to KEEP or RECYCLE.

KEEP

Choose this to put blocks from the segment into the KEEP buffer pool. Maintaining an appropriately sized KEEP buffer pool lets Oracle retain the schema object in memory to avoid I/O operations. KEEP takes precedence over any NOCACHE clause you specify for a table, cluster, materialized view, or materialized view log.

Navicat Win 194

RECYCLE

Choose this to put blocks from the segment into the RECYCLE pool. An appropriately sized RECYCLE pool reduces the number of objects whose default pool is the RECYCLE pool from taking up unnecessary cache space.

Navicat Win 195

Oracle Tables

Just simply click to open an object pane for Table. A right-click displays the popup menu or by using the object pane toolbar, allowing you to create new, edit, open and delete the selected table.

Create Table

To create a new table



Select anywhere on the object pane.

Click the New Table from the object pane toolbar together with the down arrow to choose the type Normal / External / Index Organized. or

Right-click and select New Table to choose the type Normal / External / Index

Organized from the popup menu.

Edit table properties and fields on the appropriate tabs of the Table Designer.

Hint: To create new table you can also right-click the Tables node of the navigation pane and select the New Table from the popup menu.

To create a new table with the same properties as one of the existing tables has (using popup menu)

Apply to: current schema {same connection}



Select the table(s) for copying in the navigation pane/object pane.

Right-click and select the Duplicate Table from the popup menu.

The newly created table(s) will be named as "tablename_copy".

Navicat Win 196

To create a new table with the same properties as one of the existing tables has (using drag and drop method)

Apply to: current schema {same connection}



Select the table(s) for copying in the navigation pane/object pane.

Right-click and drag the chosen table(s) to the target location.

Select one of the following options: o

Copy here (Structure and Data) o o

Copy here (Structure only)

Move here o

Cancel

The newly created table(s) will be named as "tablename_copy"

Apply to: different schema {same connection} different schema {different connection (same or cross server type)} (Data Transfer tool will be activated)



Select the table(s) for copying in the object pane.

Drag and drop the chosen table(s) to the target database.

Select one of the following options: o o o

Copy here (Structure and Data)

Copy here (Structure only)

Cancel

To create a new table with modification as one of the existing tables



Select the table for modifying in the navigation pane/object pane.

Right-click and select the Design Table from the popup menu. or

Click the Design Table from the object pane toolbar.

Modify table properties and fields on the appropriate tabs of the Table Designer.

Click Save As.

Navicat Win 197

Create Table Shortcut

To create a table shortcut



Select the table for editing in the navigation pane/object pane.

Right-click and select Create Open Table Shortcut... from the popup menu.

Define the location you wish your shortcut to be saved.

Note: This option is used to provide a convenient way for you to open your table for entering data directly (Grid View/Form View) without activating the main Navicat.

Edit Table

To edit the existing table (manage its fields, indexes, foreign keys and triggers etc)



Select the table for editing in the navigation pane/object pane.

Right-click and select the Design Table from the popup menu. or

Click the Design Table from the object pane toolbar.

Edit table properties and fields on the appropriate tabs of the Table Designer.

To change the name of the table



Select the table for editing in the navigation pane/object pane.

Right-click and select the Rename from the popup menu.

Open Table (manage table data)

To open a table



Select the table for opening in the navigation pane/object pane.

Right-click and select the Open Table from the popup menu or simply double-click the table. or

Click the Open Table from the object pane toolbar.

Note: This option is only applied if you do wish Navicat loads all your images while opening the table. To open the graphical table with faster performance, use Open

Table (Quick) below.

Navicat Win 198

To open a table with graphical fields



Select the table for opening in the navigation pane/object pane.

Right-click and select the Open Table (Quick) from the popup menu.

Note: Faster performance for opening the graphical table, as BLOB fields (images) will not be loaded until you click on the cell.

Empty Table

To empty a table



Select the table in the navigation pane/object pane.

Right-click the selected table and choose Empty Table from the popup menu.

Truncate Table

To truncate a table



Select the table in the navigation pane/object pane.

Right-click the selected table and choose Truncate Table from the popup menu.

Delete Table

To delete a table



Select the table for deleting in the navigation pane/object pane.

Right-click and select the Delete Table from the popup menu. or

Click the Delete Table from the object pane toolbar.

Confirm deleting in the dialog window.

Navicat Win 199

Achieve Table Information

To achieve a table information



Select the table in the navigation pane/object pane.

Right-click the selected table and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 200

Oracle Normal Tables

Tables are the basic unit of data storage in an Oracle database. Data is stored in rows and columns. You define a table with a table name and set of columns.

In a normal (heap-organized) table, data is stored as an unordered collection (heap).

Navicat Win 201

Table Designer for Oracle Normal Tables (/Index Organized Tables)

Table Designer is the basic Navicat tool for working with tables. It allows you to create, edit and drop table's fields, indexes, foreign keys, and much more.

Note that Table Designer for Index Organized Tables differs from Normal Tables only

on the Options tab.



Refer to Editing Physical Attributes/Default Storage Characteristics .

Managing Table Comment

Table SQL Preview

Navicat Win 202

Oracle Table Fields

Table fields are managed on the Fields tab of the Table Designer. Just simply click a field for editing. A right-click displays the popup menu or by using the field toolbar, allowing you to create new and drop the selected field.

Add Field

To add a field to the table



Open the table in the Table Designer.

Open the Fields tab.

Right-click and select the Add Field from the popup menu or click the Add Field from the toolbar.

Edit field properties.

To add a new field with modification as one of the existing fields



Open the table in the Table Designer.

Open the Fields tab.

Select field.

Right-click and select the Duplicate Field from the popup menu.

Edit field properties.

Edit Field

To edit the table field



Open the table in the Table Designer.

Open the Fields tab.

Simply click on the field to edit.

Navicat Win 203

Delete Field

To delete the table field



Open the table in the Table Designer.

Open the Fields tab.

Right-click and select the Delete Field from the popup menu or click the Delete

Field from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 204

Setting Oracle Table Field Properties

Name

The Name is a descriptive identifier for a field that can be up to 30 bytes by default (letters or numbers) including spaces. The names should be descriptive enough that anyone can easily identify them when viewing or editing records. For example, LastName, FirstName,

StreetAddress, or HomePhone.

Use the Name edit box to set the field name. Note that the name of the field must be unique among all the field names in the table.

Type

After you name a field, you choose a data type for the data to be contained in the field. When you choose a field's data type, you are deciding:



 What kind of values to allow in the field. You cannot store text in field with the

Numeric data type.

How much storage space Oracle is to set aside for the data in that field.

What types of operations can be performed on the values in that field.

The Type dropdown list defines the type of the field data.

The following table shows all the built-in general-purpose data types.

Name

CHAR

NCHAR

VARCHAR2

Description fixed-length character strings fixed-length Unicode character data variable-length character strings

VARCHAR

NVARCHAR2

CLOB

NCLOB variable-length character strings variable-length Unicode character data database character set data

Unicode national character set data

Navicat Win 205

Navicat Win

LONG

NUMBER

DATE

INTERVAL DAY TO SECOND

INTERVAL YEAR TO MONTH

TIMESTAMP variable-length character data containing up to 2 gigabytes of information fixed and floating-point numbers point-in-time values (dates and times) period of time in terms of days, hours, minutes, and seconds stores a period of time using the YEAR and MONTH datetime fields point-in-time values (dates and times) (includes fractional seconds)

TIMESTAMP WITH TIME ZONE TIMESTAMP with explicit time zone information

BLOB unstructured binary data in the database

BFILE

RAW unstructured binary data in operating-system files outside the database can be indexed and is used for data that is not to be interpreted by Oracle Database

LONG RAW

ROWID

CHARACTER

CHARACTER VARYING

CHAR VARYING

NATIONAL CHARACTER cannot be indexed and is used for data that is not to be interpreted by Oracle Database the address (rowid) of every row in the database

=CHAR 1

=VARCHAR2 1

=NCHAR 1

=NCHAR 1 NATIONAL CHAR

NATIONAL CHARACTER

VARYING

=NVARCHAR2 1

NATIONAL CHAR VARYING =NVARCHAR2 1

NCHAR VARYING =NVARCHAR2 1

NUMERIC

DECIMAL

INTEGER

INT

=NUMBER 1

=NUMBER(38) 1

SMALLINT

FLOAT

DOUBLE PRECISION

REAL

=NUMBER(38) 1

=FLOAT(126) 1

=FLOAT(63) 1

206

Note: These are ANSI datatypes and datatypes from the IBM products SQL/DS and DB2.

Oracle recognizes these datatypes and converts them to the equivalent Oracle datatype.

Click here for detailed description on these datetypes.

Length and Scale

Use the Length edit box to define the precision (total number of digits) of the field and use

Scale edit box to define the scale (number of digits to the right of the decimal point) for

numeric column.

Note: Be careful when shortening the field length as it might result in data loss.

How scale factors affect numeric data storage:

Input Data

7,456,123.89

Specified As

NUMBER

NUMBER(*,1)

NUMBER(9)

NUMBER(9,2)

NUMBER(9,1)

NUMBER(6)

NUMBER(7,-2)

Stored As

7456123.89

7456123.9

7456124

7456123.89

7456123.9 not accepted, exceeds precision

7456100

Allow Null

Allow the NULL values for the field.

Primary Key

A Primary Key is a single field or combination of fields that uniquely defines a record. None of the fields that are part of the primary key can contain a null value.

Primary Key Name

Right-click and select Primary Key Name from the popup menu to enter the primary key constraint name.

Navicat Win 207

Setting Other Oracle Table Field Properties

For INTERVAL DAY TO SECOND data type:

Leading Field Precision

Set the number of digits in the leading field. Accepted values are 0 to 9. The default is 2.

Fractional Seconds Precision

Set the number of digits in the fractional part of the SECOND datetime field. Accepted values are 1 to 9.

For INTERVAL YEAR TO MONTH data type:

Year Precision

Set the number of digits in the year. The default is 2.

For TIMESTAMP, TIMESTAMP WITH TIME ZONE, TIMESTAMP WITH LOCAL TIME

ZONE data types:

Fractional Seconds Precision

Set the number of digits in the fractional part of the SECOND datetime field. Accepted values are 1 to 9.

For CHAR, VARCHAR2 data types:

Unit

Set the unit either in BYTE or CHAR.

For COMPLEX data types:

Object Schema

Set the object schema for the field.

Object Type

Set the object type for the field.

For most data types:

Default

Set the default value for the field.

Navicat Win 208

For all data types:

Comment

Set any optional text describing the current field.

Navicat Win 209

Oracle Table Indexes

Indexes are optional structures associated with tables and clusters. You can create indexes on one or more columns of a table to speed SQL statement execution on that table. An Oracle

Database index provides a faster access path to table data. Indexes are the primary means of reducing disk I/O when properly used.

You can create many indexes for a table as long as the combination of columns differs for each index. You can create more than one index using the same columns if you specify distinctly different combinations of the columns.

Add Index

To add a table index



Open the table in the Table Designer.

Open the Indexes tab.

Right-click and select the Add Index from the popup menu or click the Add

Index from the toolbar.

Edit index properties.

Edit Index

To edit a table index



Open the table in the Table Designer.

Open the Indexes tab.

Just simply click/double-click on the index to edit.

Navicat Win 210

Delete Index

To delete a table index



Open the table in the Table Designer.

Open the Indexes tab.

Right-click on the index to delete and select the Delete Index from the popup menu or click the Delete Index from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 211

Setting Oracle Table Index Properties

Use the Name edit box to set the index name.

To include field(s) in the index, just simply double-click the Fields field or click to open the editor for editing.

The Index Type dropdown list defines the type of the table index. Oracle Database provides several indexing schemes.

Non-unique

Non-unique indexes do not impose the restriction of unique indexes on the column values.

Unique

Unique indexes guarantee that no two rows of a table have duplicate values in the key column (or columns).

Bitmap

In a bitmap index, a bitmap for each key value is used instead of a list of rowids.

Parallel With Degree

Parallel indexing can improve index performance when you have a large amount of data, and have multiple CPUs. Enter the degree that determines the number of separate indexing processes.

Tablespace

The tablespace in which to create the index. An index can be created in the same or different tablespace as the table it indexes.

Navicat Win 212

Schema

The schema in which to create the index.

Note:

To create an index in your own schema, at least one of the following conditions must be true:



The table or cluster to be indexed is in your own schema.

You have INDEX privilege on the table to be indexed.

You have CREATE ANY INDEX system privilege.

To create an index in another schema, all of the following conditions must be true:



You have CREATE ANY INDEX system privilege.

The owner of the other schema has a quota for the tablespaces to contain the index or index partitions, or UNLIMITED TABLESPACE system privilege.

Navicat Win 213

Oracle Table Foreign Keys

A foreign key specifies that the values in a column (or a group of columns) must match the values appearing in some row of another table. We say this maintains the referential integrity between two related tables.

Add Foreign Key

To add a foreign key



Open the table in the Table Designer.

Open the Foreign Keys tab.

Right-click and select the Add Foreign Key from the popup menu or click the

Add Foreign Key from the toolbar.

Edit foreign key properties.

Edit Foreign Key

To edit a foreign key



Open the table in the Table Designer.

Open the Foreign Keys tab.

Just simply click/double-click on the foreign key to edit.

Delete Foreign Key

To delete a foreign key



Open the table in the Table Designer.

Open the Foreign Keys tab.

Right-click on the foreign key to delete and select the Delete Foreign Key from the popup menu or click the Delete Foreign Key from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 214

Setting Oracle Table Foreign Key Properties

Use the Name edit box to enter a name for the new key and then select a table field to include in the key from the Fields group.

Use the Reference Schema, Reference Table and Reference Constraint dropdown lists to select a foreign schema, table and constraint respectively.

To include field(s) to the key, just simply double-click the Fields field or click to open the editor(s) for editing.

The On Delete dropdown list defines the type of the actions to be taken.

No Action (default)

Referenced key values will not be updated or deleted.

Cascade

Delete any rows referencing the deleted row, or update the value of the referencing column to the new value of the referenced column, respectively.

Set Null

Set the referencing column(s) to null.

Enable

You can choose whether to enable / disable the foreign key constraint by checking / unchecking the box.

Navicat Win 215

Oracle Table Uniques

Unique constraints ensure that the data contained in a column or a group of columns is unique with respect to all the rows in the table.

Uniques are managed on the Uniques tab of the Table Designer. Just simply click/double-click an unique field for editing. Using the toolbar below, allowing you to create new, edit and delete the selected unique field.

Add Unique

To add an unique



Open the table in the Table Designer.

Open the Uniques tab.

Right-click and select the Add Unique from the popup menu or click the Add

Unique from the toolbar.

Edit unique properties.

Edit Unique

To edit an unique



Open the table in the Table Designer.

Open the Uniques tab.

Just simply click on the unique to edit.

Delete Unique

To delete an unique



Open the table in the Table Designer.

Open the Uniques tab.

Right-click on the unique to delete and select the Delete Unique from the popup menu or click the Delete Unique from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 216

Oracle Table Setting Unique Properties

Use the Name edit box to set the unique name.

Fields

To set field(s) as unique, just simply double-click the Fields field or click to open the editor(s) for editing.

Enable

You can choose whether to enable / disable the unique constraint by checking / unchecking the box.

Navicat Win 217

Oracle Table Checks

A check constraint is the most generic constraint type. It allows you to specify that the value in a certain column must satisfy a Boolean (truth-value) expression.

Checks are managed on the Checks tab of the Table Designer. Just simply click/double-click a check field for editing. Using the check toolbar, allowing you to create new, edit and delete the selected check field.

Add Check

To add a check



Open the table in the Table Designer.

Open the Checks tab.

Right-click and select the Add Check from the popup menu or click the Add

Check from the toolbar.

Edit check properties.

Edit Check

To edit a check



Open the table in the Table Designer.

Open the Checks tab.

Just simply click on the check to edit.

Delete Check

To delete a check



Open the table in the Table Designer.

Open the Checks tab.

Right-click on the check to delete and select the Delete Check from the popup menu or click the Delete Check from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 218

Setting Oracle Table Check Properties

Use the Name edit box to set the check name.

Check

Set the condition for checking, e.g. "field_name1 > 0 AND field_name2 > field_name1" in the Check edit box. A check constraint specified as a column constraint should reference that column's value only, while an expression appearing in a table constraint may reference multiple columns.

Definition

Type in the definition for the check constraint.

Enable

You can choose whether to enable / disable the check constraint by checking / unchecking the box.

Navicat Win 219

Oracle Table Triggers

A trigger is a specification that the database should automatically execute a particular function whenever a certain type of operation is performed. Triggers can be defined to execute either before or after any INSERT, UPDATE, or DELETE operation, either once per modified row, or once per SQL statement.

Add Trigger

To add a trigger



Open the table in the Table Designer.

Open the Triggers tab.

Right-click and select the Add Trigger from the popup menu or click the Add

Trigger from the toolbar.

Edit trigger properties.

Edit Trigger

To edit a trigger



Open the table in the Table Designer.

Open the Triggers tab.

Just simply click on the trigger to edit.

Delete Trigger

To delete a trigger



Open the table in the Table Designer.

Open the Triggers tab.

Right-click on the trigger to delete and select the Delete Trigger from the popup menu or click the Delete Trigger from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 220

Setting Oracle Table Trigger Properties

Name

Set the trigger name.

Compound

Check to set the trigger as a compound trigger.

Note: Support from Orac1e 11g or later.

Row trigger

Check to set the trigger as a row trigger.

Fires

Specify the trigger timing whether the trigger action is to be run before or after the triggering statement.

INSERT - fires the trigger whenever an INSERT statement adds a row to a table or adds an element to a nested table.

UPDATE - fires the trigger whenever an UPDATE statement changes a value in one of the columns specified in Update of Fields. If no Update of Fields are present, the trigger will be fired whenever an UPDATE statement changes a value in any column of the table or nested table.

DELETE - fires the trigger whenever a DELETE statement removes a row from the table or removes an element from a nested table.

Update Of Fields

Specify the fields for UPDATE statement trigger upon necessary.

Enable

You can choose whether to enable / disable the trigger constraint by checking / unchecking the box.

Navicat Win 221

Definition

Type in the definition for the trigger.

Example:

BEGIN

add_job_history(:old.employee_id, :old.hire_date, sysdate,

:old.job_id, :old.department_id);

END;

Advanced

When Clause

Specify the trigger condition, which is a SQL condition that must be satisfied for the database to fire the trigger. This condition must contain correlation names and cannot contain a query.

Referencing Old

Specify correlation names. The default correlation names are OLD and NEW.

Referencing New

Specify correlation names. The default correlation names are OLD and NEW.

Follows

Specify the relative firing order of triggers of the same type.

Note: Support from Orac1e 11g or later.

Schema

Define the trigger on the current schema.

Navicat Win 222

Oracle Table Options

Tablespace

Define a tablespace different from the default tablespace to create a table.

Logging

Specify whether creation of a database object will be logged in the redo log file (LOGGING) or not (NOLOGGING).

Compression

Specify whether to compress data segments to reduce disk use. It is valid only for heap-organized tables.

 COMPRESS - enables table compression.



COMPRESS FOR ALL OPERATIONS - attempts to compress data during all DML operations on the table.

COMPRESS FOR DIRECT_LOAD OPERATIONS - attempts to compress data during direct-path INSERT operations when it is productive to do so.

 NOCOMPRESS - disables table compression.

Cache

Indicate how blocks are stored in the buffer cache.

 CACHE - indicates that the blocks retrieved for this table are placed at the most

 recently used end of the least recently used (LRU) list in the buffer cache when a full table scan is performed.

NOCACHE - indicates that the blocks retrieved for this table are placed at the least recently used end of the LRU list in the buffer cache when a full table scan is performed.

Parallel With Degree

Specify the degree of parallelism, which is the number of parallel threads used in the parallel operation.

Row Movement

With the option on, it allows the database to move a table row. It is possible for a row to move, for example, during table compression or an update operation on partitioned data.

Physical Attributes

Navicat Win 223

Oracle External Tables

External tables access data in external sources as if it were in a table in the database. While creating external tables, you are actually creating metadata in the data dictionary that enables you to access external data.

Note that external tables are read only. No DML operations are possible and no index can be created.

Navicat Win 224

Table Designer for Oracle External Tables

Table Designer for External Tables allows you to create, edit table's fields, external properties and access parameters etc.



Managing External Table Fields

Managing External Table External Properties

Managing External Table Access Parameters

External Table SQL Preview

Navicat Win 225

Fields for Oracle External Tables

Add Field

To add a field to the table



Open the table in the Table Designer.

Open the Fields tab.

Right-click and select the Add Field from the popup menu or click the Add Field from the toolbar.

Edit field properties.

To add a new field with modification as one of the existing fields



Open the table in the Table Designer.

Open the Fields tab.

Select field.

Right-click and select the Duplicate Field from the popup menu.

Edit field properties.

Edit Field

To edit the table field



Open the table in the Table Designer.

Open the Fields tab.

Simply click on the field to edit.

Navicat Win 226

Delete Field

To delete the table field



Open the table in the Table Designer.

Open the Fields tab.

Right-click and select the Delete Field from the popup menu or click the Delete

Field from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 227

Setting Field Properties for Oracle External Tables

Name

The Name is a descriptive identifier for a field that can be up to 30 characters by default

(letters or numbers) including spaces. The names should be descriptive enough that anyone can easily identify them when viewing or editing records. For example, LastName, FirstName,

StreetAddress, or HomePhone.

Use the Name edit box to set the field name. Note that the name of the field must be unique among all the field names in the table.

Type

After you name a field, you choose a data type for the data to be contained in the field. When you choose a field's data type, you are deciding:



 What kind of values to allow in the field. You cannot store text in field with the

Numeric data type.

How much storage space Oracle is to set aside for the data in that field.

What types of operations can be performed on the values in that field.

The Type dropdown list defines the type of the field data.

The following table shows all the built-in general-purpose data types.

Name

CHAR

NCHAR

VARCHAR2

Description fixed-length character strings fixed-length Unicode character data variable-length character strings

VARCHAR

NVARCHAR2

CLOB

NCLOB variable-length character strings variable-length Unicode character data database character set data

Unicode national character set data

Navicat Win 228

Navicat Win

LONG

NUMBER

DATE

INTERVAL DAY TO SECOND

INTERVAL YEAR TO MONTH

TIMESTAMP WITH TIME ZONE TIMESTAMP with explicit time zone information

BLOB unstructured binary data in the database

BFILE

RAW unstructured binary data in operating-system files outside the database can be indexed and is used for data that is not to be interpreted by Oracle Database

LONG RAW

ROWID

CHARACTER

CHARACTER VARYING

CHAR VARYING

NATIONAL CHARACTER cannot be indexed and is used for data that is not to be interpreted by Oracle Database the address (rowid) of every row in the database

=CHAR 1

=VARCHAR2 1

=NCHAR 1

=NCHAR 1 NATIONAL CHAR

NATIONAL CHARACTER

VARYING

=NVARCHAR2 1

NATIONAL CHAR VARYING =NVARCHAR2 1

NCHAR VARYING =NVARCHAR2 1

NUMERIC

DECIMAL

INTEGER

INT

=NUMBER 1

=NUMBER(38) 1

SMALLINT

FLOAT

DOUBLE PRECISION

REAL

=NUMBER(38) 1

=FLOAT(126) 1

=FLOAT(63) 1

229

Note: These are ANSI datatypes and datatypes from the IBM products SQL/DS and DB2.

Oracle recognizes these datatypes and converts them to the equivalent Oracle datatype.

Click here for detailed description on these datetypes.

Length and Scale

Use the Length edit box to define the precision (total number of digits) of the field and use

Scale edit box to define the scale (number of digits to the right of the decimal point) for

numeric column.

Note: Be careful when shortening the field length as it might result in data loss.

How scale factors affect numeric data storage:

Input Data

7,456,123.89

Specified As

NUMBER

NUMBER(*,1)

NUMBER(9)

NUMBER(9,2)

NUMBER(9,1)

NUMBER(6)

NUMBER(7,-2)

Stored As

7456123.89

7456123.9

7456124

7456123.89

7456123.9 not accepted, exceeds precision

7456100

Navicat Win 230

Setting Other Field Properties for Oracle External Tables

For INTERVAL DAY TO SECOND data type:

Leading Field Precision

Set the number of digits in the leading field. Accepted values are 0 to 9. The default is 2.

Fractional Seconds Precision

Set the number of digits in the fractional part of the SECOND datetime field. Accepted values are 1 to 9.

For INTERVAL YEAR TO MONTH data type:

Year Precision

Set the number of digits in the year. The default is 2.

For TIMESTAMP, TIMESTAMP WITH TIME ZONE, TIMESTAMP WITH LOCAL TIME

ZONE data types:

Fractional Seconds Precision

Set the number of digits in the fractional part of the SECOND datetime field. Accepted values are 1 to 9.

For CHAR, VARCHAR2 data types:

Unit

Set the unit either in BYTE or CHAR.

For COMPLEX data types:

Object Schema

Set the object schema for the field.

Object Type

Set the object type for the field.

Navicat Win 231

External Properties for Oracle External Tables

Default Directory

Specify the default directory for the external table.

Directory

Set the external directory.

Location

Set the external source location.

Access Driver

Specify the access driver for the external table. The default type for external tables is

ORACLE_LOADER.

Reject Limit

Specify the limit on the number of errors that can occur during a query of the external data.

Parallel With Degree

Check to enable parallel query on the data sources and specify the degree of parallel access.

Navicat Win 232

Access Parameters for Oracle External Tables

Describe the mapping of the external data to the Oracle Database data columns.

Using CLOB

Check this option to get a CLOB data value of the returned query.

Navicat Win 233

Oracle Index Organized Tables

An index-organized table has a storage organization that is a variant of a primary B-tree.

Data for an index-organized table is stored in a B-tree index structure in a primary key sorted manner. Each leaf block in the index structure stores both the key and nonkey columns.

Index-organized tables have full table functionality. They support features such as constraints, triggers etc with additional features such as key compression.

Navicat Win 234

Table Designer for Oracle Index Organized Tables

Table Designer for Index Organized Tables allows you to create, edit and drop table's fields, indexes, foreign keys, and much more.

Note that Table Designer for Index Organized Tables differs from Normal Tables only on the Options tab. Therefore, we will refer to Table Designer for Normal Table(/Index

Organized Table) on the following similar chapters:



Managing Table Comment

Table SQL Preview

Options tab for Index Organized Table:



Refer to Editing Physical Attributes/Default Storage Characteristics .

Navicat Win 235

Options for Oracle Index Organized Tables

Tablespace

Define a tablespace different from the default tablespace to create a table.

Logging

Specify whether creation of a database object will be logged in the redo log file (LOGGING) or not (NOLOGGING).

Parallel With Degree

Specify the degree of parallelism, which is the number of parallel threads used in the parallel operation.

Row Movement

With the option on, it allows the database to move a table row. It is possible for a row to move, for example, during table compression or an update operation on partitioned data.

Physical Attributes

IOT Properties

Key Compress

Check this option to enable key compression. Upon necessary, you can also specify the prefix length (as the number of key columns), which identifies how the key columns are broken into a prefix and suffix entry.

Mapping Table

Specify if there is a mapping table for the index-organized table. Note that a mapping table is required for creating bitmap indexes on an index-organized table.

% Threshold

When an overflow segment is being used, it defines the maximum size of the portion of the row that is stored in the index block, as a percentage of block size.

Overflow Properties

Check to enable an overflow storage area.

Note: After saving the table, this option cannot be unchecked.

Navicat Win 236

Overflow Column

Specify the column to be put in a separate overflow data segment.

Overflow Tablespace

Specify the tablespace in which the overflow segment to be stored.

Overflow Logging

Specify whether creation of a database object will be logged in the redo log file

(LOGGING) or not (NOLOGGING).

Overflow Physical Attributes

Refer to Editing Physical Attributes/Default Storage Characteristics .

Navicat Win 237

Oracle Views

Views are useful for allowing users to access a set of relations (tables) as if it were a single table, and limiting their access to just that. Views can also be used to restrict access to rows

(a subset of a particular table).

Just simply click to open an object pane for View. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit, open and delete the selected view.

Create View

To create a new view



Select anywhere on the object pane.

Click the New View from the object pane toolbar. or

Right-click and select New View from the popup menu.

Edit view properties on the appropriate tabs of the View Designer.

Hint: To create new view you can also right-click the Views node of the navigation pane and select the New View from the popup menu.

To create a new view with the same properties as one of the existing views has (using drag and drop method)

Apply to: current schema {same connection}



Select the view(s) for copying in the navigation pane/object pane.

Right-click and drag the chosen view(s) to the target location.

Select one of the following options: o

Copy here (Structure and Data) o o

Copy here (Structure only)

Move here o

Cancel

The newly created view(s) will be named as "viewname_copy".

Navicat Win 238

Apply to: different schema {same connection} different schema {different connection} (Data Transfer tool will be activated)



Select the view(s) for copying in the object pane.

Drag and drop the chosen view(s) to the target database.

Select one of the following options: o o o

Copy here (Structure and Data)

Copy here (Structure only)

Cancel

To create a new view with modification as one of the existing views



Select the view for modifying in the navigation pane/object pane.

Right-click and select the Design View from the popup menu. or

Click the Design View from the object pane toolbar.

Modify view properties on the appropriate tabs of the View Designer.

Click Save As.

To create a new view with loading from a SQL file



Select anywhere on the object pane.

Click the New View from the object pane toolbar. or

Right-click and select New View from the popup menu.

Click Load.

Create View Shortcut

To create a view shortcut



Select the view for editing in the navigation pane/object pane.

Right-click and select Create Open View Shortcut... from the popup menu.

Define the location you wish your shortcut to be saved.

Note: This option is used to provide a convenient way for you to open your view for entering data directly (Grid View/Form View) without activating the main Navicat.

Navicat Win 239

Edit View

To edit the existing view (manage its SQL definition etc)



Select the view for editing in the navigation pane/object pane.

Right-click and select the Design View from the popup menu. or

Click the Design View from the object pane toolbar.

Edit view properties on the appropriate tabs of the View Designer.

To change the name of the view



Select the view for editing in the navigation pane/object pane.

Right-click and select the Rename from the popup menu.

Open View

To open a view (manage view data)



Select the view for opening in the navigation pane/object pane.

Right-click and select the Open View from the popup menu or simply double-click the view. or

Click the Open View from the object pane toolbar.

Maintain View

To maintain a view



Select the view for maintaining in the object pane.

Right-click and select the Maintain from the popup menu. o

Compile

Navicat Win 240

Delete View

To delete a view



Select the view for deleting in the navigation pane/object pane.

Right-click and select the Delete View from the popup menu. or

Click the Delete View from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve View Information

To achieve a view information



Select the view in the navigation pane/object pane.

Right-click the selected view and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 241

Oracle View Designer

View Designer is the basic Navicat tool for working with views. It allows you to create new view and edit the existing view definition (view name and the SELECT statement it implements).



Editing View Comment

View SQL Preview

Setting Parameters for Procedure/Function

Navicat Win 242

Working with Oracle View Builder (Available only in Full Version)

View Builder allows you to build views visually. It allows you to create and edit views without knowledge of SQL. See Query Builder for details.

Navicat Win 243

Editing Oracle View SQL Definition

The Definition tab allows you to edit the view definition as SQL statement (SELECT statement it implements).

Example:

SELECT

HR.EMPLOYEES.EMPLOYEE_ID

FROM

HR.EMPLOYEES

Hint: To customize the view of the editor and find out more features for sql editing, see Editor

View and More Features.

Navicat Win 244

Setting Advanced Oracle View Properties

The Advanced tab allows you to restrict the defining query of the view.

Restrict Query

Specify the name. If you omit this identifier, then Oracle automatically assigns a name of the form SYS_Cn, where n is an integer that makes the constraint name unique within the database.

Read Only

Indicate that the table or view cannot be updated.

Check option

Indicate that Oracle Database prohibits any changes to the table or view that would produce rows that are not included in the subquery.

Force On Create

Check this option if you want to create the view regardless of whether the base tables of the view or the referenced object types exist or the owner of the schema containing the view has privileges on them.

Navicat Win 245

Oracle View Preview

To preview the result of the view, click Preview on the toolbar. If the query statement is correct, the Result and Message tabs will be opened.

The Result tab displays the data of the view as a grid and the Message tab displays the message log.

Navicat Win 246

Oracle View Explain

To show the Explain Plan of the query, click Explain on the toolbar. If the query statement is correct, the Explain tab opens with the columns in the PLAN_TABLE.

Column

Operation

Object

Optimizer

Cost

Cardinality

Bytes

Partition Start

Partition ID

Access Predicates

Filter Predicates

Description

Name of the internal operation performed in this step.

Name of the table or index.

Current mode of the optimizer.

Cost of the operation as estimated by the optimizer's query approach. Cost is not determined for table access operations. The value of this column does not have any particular unit of measurement; it is merely a weighted value used to compare costs of execution plans. The value of this column is a function of the CPU_COST and

IO_COST columns.

Estimate by the query optimization approach of the number of rows accessed by the operation.

Estimate by the query optimization approach of the number of bytes accessed by the operation.

Start partition of a range of accessed partitions.

Step that has computed the pair of values of the

PARTITION_START and PARTITION_STOP columns.

Predicates used to locate rows in an access structure.

For example, start or stop predicates for an index range scan.

Predicates used to filter rows before producing them.

Navicat Win 247

Oracle View Viewer

View Viewer displays the view data as a grid. Data can be displayed in three modes:

Grid View, Form View and Text/Blob/BFile View. See Data View for details.

The toolbars of View Viewer provides the following functions for managing data:

 Commit

Make permanent all changes performed in the transaction.

Hint: The Commit button is visible only when Auto Commit is disabled under

Option Settings.

 Rollback

Undo work done in the current transaction.

Hint: The Rollback button is visible only when Auto Commit is disabled under

Option Settings.

 Export Data

Export data to MS Word, MS Excel, MS Access, TXT, DBF, HTML, SQL, RTF and more.

 Filter Data

Allow you to filter records by creating and applying filter criteria for the data grid.

 Edit TEXT/BLOB/BFile

Allow you to view and edit the content of TEXT, BLOB and BFile fields.

Navicat Win 248

Navicat Win 249

Oracle Functions/Procedures

A procedure or function is a schema object that consists of a set of SQL statements and other

PL/SQL constructs, grouped together, stored in the database, and run as a unit to solve a specific problem or perform a set of related tasks.

Procedures and functions are identical except that functions always return a single value to the caller, while procedures do not.

Create Function/Procedure

To create a new function/procedure



Select anywhere on the object pane.

Click the New Function from the object pane toolbar. or

Right-click and select New Function from the popup menu.

Edit function/procedure properties on the appropriate tabs of the Function/Procedure

Designer.

Hint: To create new function/procedure you can also right-click the Function node of the navigation pane and select the New Function from the popup menu.

Navicat Win 250

To create a new function/procedure with the same properties as one of the existing function/procedure has (using drag and drop method)

Apply to: current schema {same connection}



Select the function/procedure(s) for copying in the navigation pane/object pane.

Right-click and drag the chosen function/procedure(s) to the target location.

Select one of the following options: o

Copy here (Structure and Data) o o

Copy here (Structure only)

Move here o

Cancel

The newly created function/procedure(s) will be named as

"function/procedurename_copy".

Apply to: different schema {same connection} different schema {different connection} (Data Transfer tool will be activated)



Select the function/procedure(s) for copying in the object pane.

Drag and drop the chosen function/procedure(s) to the target database.

Select one of the following options: o o o

Copy here (Structure and Data)

Copy here (Structure only)

Cancel

Edit Function/Procedure

To edit the existing function/procedure



Select the function/procedure for editing in the navigation pane/object pane.

Right-click and select the Design Function from the popup menu or simply double-click the function/ procedure. or

Click the Design Function from the object pane toolbar.

Edit function/procedure properties on the appropriate tabs of the Function/Procedure

Designer.

Navicat Win 251

Run Function/Procedure

To run a function/procedure in the navigation pane/object pane



Select the function/procedure for executing in the navigation pane/object pane.

Click the Execute Function from the object pane toolbar. or

Right-click and select Execute Function from the popup menu.

View the returned data on the DBMS Output tab.

To run a function/procedure in the Function/Procedure Designer



Create a new function/procedure or open the existing function/procedure.

Click Run.

View the returned data on the DBMS Output tab.

Debug Function/Procedure

To debug a function/procedure in the object pane



Select the function/procedure for debugging in the object pane.

Right-click and select the Debug Function from the popup menu.

Debug the function/procedure in the Debugger.

To debug a function/procedure in the Function/Procedure Designer



Create a new function/procedure or open the existing function/procedure.

Click Debug.

Debug the function/procedure in the Debugger.

Maintain Function/Procedure

To maintain a function/procedure



Select the function/procedure for maintaining in the object pane.

Right-click and select the Maintain from the popup menu. o o

Compile

Compile for Debug

Navicat Win 252

Delete Function/Procedure

To delete a function/procedure



Select the function/procedure for deleting in the navigation pane/object pane.

Right-click and select the Delete Function from the popup menu. or

Click the Delete Function from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Function/Procedure Information

To achieve a function/procedure information



Select the function/procedure in the navigation pane/object pane.

Right-click the selected function/procedure and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 253

Oracle Function Wizard

Click the New Function from the object pane toolbar. The Function Wizard will pop up and it allows you to create a procedure/function easily.



Setting Routine Type

Editing Function/Procedure Definition

You are allowed not to show the Function Wizard when create new procedure/function.

Hint: Once uncheck the Show wizard next time, you can go to Options to enable it.

Navicat Win 254

Setting Oracle Routine Type

Specify the Name of the routine.

Select the type of the routine: Procedure or Function

Navicat Win 255

Setting Parameters for Oracle Procedure/Function

Define the parameter(s) of the procedure/function. Set the parameter Name, Type, Mode and Default Value under corresponding columns.

Navicat Win 256

Setting Return Type for Oracle Function

Select the Return Type from the list.

Note: Only function supports return type.

Navicat Win 257

Oracle Function/Procedure Designer

Function/Procedure Designer allows you to edit the existing function/procedure definition and more.



Function/Procedure SQL Preview

Viewing Function/Procedure Result

Debugging Function/Procedure

Navicat Win 258

Editing Oracle Function/Procedure Definition

Edit the function/procedure definition under the Definition tab.

The Code Outline window displays information about the function/procedure including parameter, code body, etc. To show the Code Outline window, simply choose View -> Code

Outline.

Note: Available only in Full Version.

Refresh the code outline.

Show the detail view of the code outline.

Turn mouse over highlight on or off.

Expand the selected item.

Collapse the selected item.

Toggle sorting by position.

The SQL statements for creating procedures are CREATE PROCEDURE. In practice, it is best to use a CREATE OR REPLACE statement. The general form of these statements follows.

CREATE OR REPLACE

PROCEDURE "" AS

BEGIN

-- routine body goes here, e.g.

-- DBMS_OUTPUT.PUT_LINE('Navicat for Oracle');

END;

Hint: To customize the view of the editor and find out more features for sql editing, see Editor

View and More Features.

Navicat Win 259

Viewing Oracle Function/Procedure Result

To run the function/procedure click Run on the toolbar. If the SQL statement is correct, the statement will be executed and, if the statement is supposed to return data, the

Message and DBMS Output tabs open with the message log and data returned by the function/procedure. If an error occurs while executing the function/procedure, execution stops, the appropriate error message is displayed.

If the function/procedure requires input parameter, the Input Parameters box will popup.

Navicat Win 260

Debugging Oracle Function/Procedure (Available only in Full Version)

To debug the function/procedure click

Debug on the toolbar to launch the Oracle

Debugger .

You can add/remove breakpoints for debugging by clicking in the grey area beside each statement.

Enter the Input Parameters if necessary.

Navicat Win 261

Oracle Database Links

Database link is a named schema object that describes a path from one database to another and are implicitly used when a reference is made to a global object name in a distributed database. After you have created a database link, you can use it to refer to tables and views on the other database.

Just simply click -> Database Link to open an object pane for Database Link. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new and delete the selected database link.

Create Database Link

To create a new database link



Select anywhere on the object pane.

Click the New Database Link from the object pane toolbar. or

Right-click and select New Database Link from the popup menu.

Edit database link properties on the appropriate tabs of the Database Link Designer.

Delete Database Link

To delete a database link



Select the database link for deleting in the object pane.

Right-click and select the Delete Database Link from the popup menu. or

Click the Delete Database Link from the object pane toolbar.

Confirm deleting in the dialog window.

Navicat Win 262

Achieve Database Link Information

To achieve a database link information



Select the database link in the object pane.

Right-click the selected database link and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 263

Oracle Database Link Designer

Database Link Designer is the basic Navicat tool for working with database links. It allows you to create new database link.



Editing Database Link General

Database Link SQL Preview

Navicat Win 264

Edit Oracle Database Link General

Service Name

Specify the service name of a remote database.

User Name

The user name used to connect to the remote database using a fixed user database link.

Password

The password for connecting to the remote database.

Current user

With this option checked, a current user database link is created. The current user must be a global user with a valid account on the remote database.

Shared

Fill in Authentication username and Authentication password when Shared option is enabled.

Navicat Win 265

Oracle Indexes

Index provides a faster access path to table data. It is created using one or more columns of a table to speed SQL statement execution on that table.

Just simply click -> Index to open an object pane for Index. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected Index.

Create Index

To create a new index



Select anywhere on the object pane.

Click the New Index from the object pane toolbar. or

Right-click and select New Index from the popup menu.

Edit index properties on the appropriate tabs of the Index Designer.

To create a new index with modification as one of the existing index



Select the index for modifying in the object pane.

Right-click and select the Design Index from the popup menu or simply double-click the index. or

Click the Design Index from the object pane toolbar.

Modify index properties on the appropriate tabs of the Index Designer.

Click Save As.

Edit Index

To edit the existing index (manage its properties etc)



Select the index for editing in the object pane.

Right-click and select the Design Index from the popup menu or simply double-click the index. or

Click the Design Index from the object pane toolbar.

Edit index properties on the appropriate tabs of the Index Designer.

Navicat Win 266

To change the name of the index



Select the index for editing in the object pane.

Right-click and select the Rename from the popup menu.

Maintain Index

To maintain an index



Select the index for maintaining in the object pane.

Right-click and select the Maintain from the popup menu. o o

Rebuild

Make Unusable o o o o

Coalesce

Compute Statistics

Monitoring Usage

No Monitoring Usage

Delete Index

To delete an index



Select the index for deleting in the object pane.

Right-click and select the Delete Index from the popup menu. or

Click the Delete Index from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Index Information

To achieve an index information



Select the index in the object pane.

Right-click the selected index and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 267

Oracle Index Designer

Index Designer is the basic Navicat tool for working with indexes. It allows you to create new index and edit the existing index properties.



Editing Index General

Editing Advanced Index Properties

Index SQL Preview

Navicat Win 268

Editing Oracle Index General

Type

The types of the index.

Normal

Normal Index (A B-tree index)

Unique

Unique Index (No two rows of a table have duplicate values in the key columns)

Bitmap

Bitmap Index (A bitmap for each key value)

Domain

Domain Index (Instances of an application-specific index)

Cluster

Cluster Index

Navicat Win 269

Oracle Normal Index

A normal index does not impose restrictions on the column values.

Type

Choose between Normal, Unique, Bitmap, Domain and Cluster.

Table schema

The schema that contains the index.

Table name

The table name.

Fields

Use the Name dropdown list to select the field name and Descend dropdown list to define the order of the index (ASC or DESC).

Navicat Win 270

Oracle Unique Index

A unique index indicates that no two rows of a table have duplicate values in the key columns.

Type

Choose between Normal, Unique, Bitmap, Domain and Cluster.

Table schema

The schema that contains the index.

Table name

The table name.

Fields

Use the Name dropdown list to select the field name and Descend dropdown list to define the order of the index (ASC or DESC).

Navicat Win 271

Oracle Bitmap Index

A bitmap index created with a bitmap for each distinct key, rather than indexing each row separately. Bitmap indexes store the rowids associated with a key value as a bitmap. Each bit in the bitmap corresponds to a possible rowid.

Type

Choose between Normal, Unique, Bitmap, Domain and Cluster.

Table schema

The schema that contains the index.

Table name

The table name.

Fields

Use the Name dropdown list to select the field name and Descend dropdown list to define the order of the index (ASC or DESC).

Bitmap Join Index

In addition to a bitmap index on a single table, you can create a bitmap join index, which is a bitmap index for the join of two or more tables. A bitmap join index is a space efficient way of reducing the volume of data that must be joined by performing restrictions in advance.

Fields

Use the Schema, Table and Name dropdown lists to select the schema, table and field name and Descend dropdown list to define the order of the index (ASC or DESC).

Bitmap Join

Use the InnerSchema, InnerTable, InnerField, OuterSchema, OuterTable and

OuterField dropdown lists to select joined schemas, tables and fields respectively.

Navicat Win 272

Oracle Domain Index

A domain index is an index designed for a specialized domain, such as spatial or image processing. Users can build a domain index of a given type after the designer creates the indextype.

Type

Choose between Normal, Unique, Bitmap, Domain and Cluster.

Table schema

The schema that contains the index.

Table name

The table name.

Column

The column which the index is based.

Index Type

Schema

The schema of the indextype.

Type

Select the created or built-in indextypes.

Parameters

Information about the path table and about the secondary indexes corresponding to the components of XMLIndex. The maximum length of the parameter string is 1000 characters.

Navicat Win 273

Oracle Cluster Index

A cluster index is an index designed for a cluster.

Type

Choose between Normal, Unique, Bitmap, Domain and Cluster.

Table schema

The schema that contains the index.

Cluster name

The name of the cluster.

Navicat Win 274

Editing Advanced Oracle Index Properties

Unusable

An unusable index must be rebuilt, or dropped and re-created, before it can be used.

Tablespace

The name of the tablespace to hold the index.

Compress

To enable key compression, which eliminates repeated occurrence of key column values and may substantially reduce storage.

Note: No compression for Bitmap Indexes.

Parallel

The creation of the index will be parallelized.

Reverse

To store the bytes of the index block in reverse order, excluding the rowid.

Logging

The creation of the index will be logged in the redo log file.

No Logging

The creation of the index will be not logged in the redo log file.

Visibility

Visible

Specify the index is visible to the optimizer.

Invisible

Specify the index is invisible to the optimizer.

Create / Rebuild Option

Online

To indicate that DML operations on the table will be allowed during creation of the index.

Navicat Win 275

No Sort

To indicate to the database that the rows are already stored in the database in ascending order, so that Oracle Database does not have to sort the rows when creating the index.

Setting Advanced Java Properties

Set the physical attributes of an index.

Navicat Win 276

Oracle Java

Java is an object-oriented programming language efficient for application-level programs.

You can write and load applications within the database.

Just simply click -> Java to open an object pane for Java. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected Java.

Create Java

To create a new Java



Select anywhere on the object pane.

Click the New Java from the object pane toolbar. or

Right-click and select New Java from the popup menu.

Edit Java properties on the appropriate tabs of the Java Designer.

To create a new Java with modification as one of the existing Java



Select the Java for modifying in the object pane.

Right-click and select the Design Java from the popup menu or simply double-click the Java. or

Click the Design Java from the object pane toolbar.

Modify Java properties on the appropriate tabs of the Java Designer.

Click Save As.

Edit Java

To edit the existing Java(manage its general, advanced etc)



Select the Java for editing in the object pane.

Right-click and select the Design Java from the popup menu or simply double-click the Java. or

Click the Design Java from the object pane toolbar.

Edit Java properties on the appropriate tabs of the Java Designer.

Navicat Win 277

Maintain Java

To maintain a Java



Select the Java for maintaining in the object pane.

Right-click and select the Maintain from the popup menu. o o o

Compile or Resolve

Set AuthID Current User

Set AuthID Definer

Delete Java

To delete a Java



Select the Java for deleting in the object pane.

Right-click and select the Delete Java from the popup menu. or

Click the Delete Java from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Java Information

To achieve a Java information



Select the Java in the object pane.

Right-click the selected Java and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 278

Oracle Java Designer

Java Designer is the basic Navicat tool for working with Java. It allows you to create new

Java and edit the existing Java properties.



Editing Java General

Java SQL Preview

Navicat Win 279

Editing Oracle Java General

You can create a Java source, class, or resource using the Java Designer.



Java Source

Java Class

Java Resource

Navicat Win 280

Oracle Java Source

Type

Choose between Java Source, Java Class and Java Resource.

Create from

BFile

Select the Directory and type the Server Filename.

Load from file

Browse the File Path of Java source file.

Plain source

Type the source code in the Source box.

Navicat Win 281

Oracle Java Class

Type

Choose between Java Source, Java Class and Java Resource.

Create from

BFile

Select the Directory and type the Server Filename.

Load from file

Browse the File Path of the Java class file.

Navicat Win 282

Oracle Java Resource

Type

Choose between Java Source, Java Class and Java Resource.

Create from

BFile

Select the Directory and type the Server Filename.

Load from file

Browse the File Path of the Java resource file.

Navicat Win 283

Setting Advanced Oracle Java Properties

Invoker Rights

Select CURRENT_USER to indicate that the methods of the class execute with the privileges of CURRENT_USER or DEFINER indicates that the methods of the class execute with the privileges of the owner of the schema in which the class resides, and that external names resolve in the schema where the class resides.

Resolver

Specify a mapping of the fully qualified Java name to a Java schema object.

Compile or Resolve

Check this to specify that Oracle Database should attempt to resolve the Java schema object that is created if this statement succeeds.

No Force

Check this to roll back the results of the CREATE command of Java if you have enabled

Compile or Resolve and the resolution or compilation fails. If you do not specify this option, then Oracle Database takes no action if the resolution or compilation fails, and the created schema object remains.

Navicat Win 284

Oracle Materialized Views

Materialized view is a schema object that can be used to summarize, compute, replicate, and distribute data.

Just simply click -> Materialized View to open an object pane for Materialized View.

A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected materialized view.

Create Materialized View

To create a new materialized view



Select anywhere on the object pane.

Click the New Materialized View from the object pane toolbar. or

Right-click and select New Materialized View from the popup menu.

Edit materialized view properties on the appropriate tabs of the Materialized View

Designer.

To create a new materialized view with modification as one of the existing materialized view



Select the materialized view for modifying in the object pane.

Right-click and select the Design Materialized View from the popup menu. or

Click the Design Materialized View from the object pane toolbar.

Modify materialized view properties on the appropriate tabs of the Materialized View

Designer.

Click Save As.

To create a new materialized view with loading from a SQL file



Select anywhere on the object pane.

Click the New Materialized View from the object pane toolbar. or

Right-click and select New Materialized View from the popup menu.

Click Load.

Navicat Win 285

Create Materialized View Shortcut

To create a materialized view shortcut



Select the materialized view for editing in the object pane.

Right-click and select Create Open Materialized View Shortcut... from the popup menu.

Define the location you wish your shortcut to be saved.

Note: This option is used to provide a convenient way for you to open your materialized view for editing data directly (Grid View/Form View) without activating the main Navicat.

Edit Materialized View

To edit the existing materialized view (manage its properties etc)



Select the materialized view for editing in the object pane.

Right-click and select the Design Materialized View from the popup menu. or

Click the Design Materialized View from the object pane toolbar.

Edit materialized view properties on the appropriate tabs of the Materialized View

Designer.

Open Materialized View

To open a materialized view (manage materialized view data)



Select the materialized view for opening in the object pane.

Right-click and select the Open Materialized View from the popup menu or simply double-click the materialized view. or

Click the Open Materialized View from the object pane toolbar.

Navicat Win 286

Maintain Materialized View

To maintain a materialized view



Select the materialized view for maintaining in the object pane.

Right-click and select the Maintain from the popup menu. o o

Enable Row Movement

Shrink o o

Compile

Force Refresh

Delete Materialized View

To delete a materialized view



Select the materialized view for deleting in the object pane.

Right-click and select the Delete Materialized View from the popup menu. or

Click the Delete Materialized View from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Materialized View Information

To achieve a materialized view information



Select the materialized view in the object pane.

Right-click the selected materialized view and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 287

Oracle Materialized View Designer

Materialized View Designer is the basic Navicat tool for working with materialized views.

It allows you to create new materialized view and edit the existing materialized view properties.



Working with Materialized View Builder

Editing Materialized View SQL Definition

Setting Advanced Materialized View Properties

Editing Materialized View Comment

Materialized View SQL Preview

Navicat Win 288

Working with Oracle Materialized View Builder (Available only in Full

Version)

View Builder allows you to build views visually. It allows you to create and edit materialized views without knowledge of SQL. See Query Builder for details.

Navicat Win 289

Editing Oracle Materialized View SQL Definition

The Definition tab allows you to edit the view definition as SQL statement (SELECT statement it implements).

Example:

SELECT

HR.EMPLOYEES.EMPLOYEE_ID

FROM

HR.EMPLOYEES

Hint: To customize the view of the editor and find out more features for sql editing, see Editor

View and More Features.

Navicat Win 290

Setting Advanced Oracle Materialized View Properties

Refresh Options

When

Demand

The materialized view will be refreshed on demand by calling one of the three

DBMS_MVIEW refresh procedures.

Commit

A fast refresh is to occur whenever the database commits a transaction that operates on a master table of the materialized view.

Automatic

The database automatically refresh the materialized view with the automatic refresh time.

Never

The materialized view will not be refreshed with any Oracle Database refresh mechanism or packaged procedure.

Method

FORCE

When a refresh occurs, Oracle Database will perform a fast refresh if one is possible or a complete refresh if fast refresh is not possible.

FAST

A incremental refresh method, which performs the refresh according to the changes that have occurred to the master tables.

COMPLETE

A complete refresh method, which is implemented by executing the defining query of the materialized view.

Start On

A datetime expression for the first automatic refresh time.

Next

A datetime expression for calculating the interval between automatic refreshes.

Navicat Win 291

Note: To edit the datetime, just simply click ... and choose / enter the desired data.

Type

Primary Key

A primary key materialized view. This is the default.

Row ID

A rowid materialized view.

Rollback Segment

Master

The remote rollback segment is used at the remote master site for the individual materialized view.

Local

The remote rollback segment is used for the local refresh group that contains the materialized view. This is the default.

Constraints

Enforced

Oracle Database use enforced constraints during the refresh operation.

Trusted

Oracle Database use dimension and constraint information that has been declared trustworthy by the database administrator but that has not been validated by the database.

Create Options

No Index

Check this to suppress the creation of the default index.

Build Type

Immediate

The materialized view is to be populated immediately. This is the default.

Navicat Win 292

Deferred

The materialized view is to be populated by the next refresh operation.

Prebuilt

To register an existing table as a preinitialized materialized view.

Materialized View Options

Reduced Precision

With

To authorize the loss of precision that will result if the precision of the table or materialized view columns do not exactly match the precision returned by subquery.

Without

To require that the precision of the table or materialized view columns match exactly the precision returned by subquery, or the create operation will fail. This is the default.

Compress

Data segments are compressed to reduce disk and memory use.

Parallel

Choose NOPARALLEL for serial execution or PARALLEL if you want Oracle to select a degree of parallelism equal to the number of CPUs available on all participating instances times the value of the PARALLEL_THREADS_PER_CPU initialization parameter.

With Degree

Set the default degree of parallelism for queries and DML on the materialized view after creation.

Logging

Choose LOGGING for logging the creation of Materialized view in the redo log file.

Choose NOLOGGING for no logging.

Tablespace

Choose the tablespace in which the materialized view is to be created.

Set the physical attributes of the materialized view.

Navicat Win 293

Enable Cache

The blocks retrieved for the table are placed at the most recently used end of the least recently used (LRU) list in the buffer cache when a full table scan is performed.

For Update

Check this to allow a subquery, primary key, object, or rowid materialized view to be updated. When used in conjunction with Advanced Replication, these updates will be propagated to the master.

Enable Query Rewrite

The materialized view is used for query rewrite.

Using Index Clause

Tablespace

Choose the tablespace of the index.

a Materialized View defined on the master table can be refreshed incrementally.

Set the physical attributes for the default index Oracle Database uses to maintain the materialized view data.

Navicat Win 294

Oracle Materialized View Preview

To preview the result of the view, click Preview on the toolbar. If the query statement is correct, the Result and Message tabs will be opened.

The Result tab displays the data of the view as a grid and the Message tab displays the message log.

Navicat Win 295

Oracle Materialized View Explain

To show the Explain Plan of the query, click Explain on the toolbar. If the query statement is correct, the Explain tab opens with the columns in the PLAN_TABLE.

Object

Cost

Bytes

Column

Operation

Optimizer

Cardinality

Partition Start

Partition ID

Access Predicates

Filter Predicates

Description

Name of the internal operation performed in this step. In the first row generated for a statement.

Name of the table or index.

Current mode of the optimizer.

IO_COST columns.

Estimate by the query optimization approach of the number of rows accessed by the operation.

Estimate by the query optimization approach of the number of bytes accessed by the operation.

Start partition of a range of accessed partitions.

Step that has computed the pair of values of the

PARTITION_START and PARTITION_STOP columns.

Predicates used to locate rows in an access structure. For example, start or stop predicates for an index range scan.

Predicates used to filter rows before producing them.

Navicat Win 296

Oracle Materialized View Logs

Materialized view log is a schema object that records changes to a master table's data so that

Just simply click -> Materialized View Log to open an object pane for Materialized

View Log. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected materialized view log.

Create Materialized View Log

To create a new materialized view log



Select anywhere on the object pane.

Click the New Materialized View Log from the object pane toolbar. or

Right-click and select New Materialized View Log from the popup menu.

Edit materialized view log properties on the appropriate tabs of the Materialized View

Log Designer.

To create a new materialized view log with modification as one of the existing materialized view log



Select the materialized view log for modifying in the object pane.

Right-click and select the Design Materialized View Log from the popup menu or simply double-click the materialized view log. or

Click the Design Materialized View Log from the object pane toolbar.

Modify materialized view log properties on the appropriate tabs of the Materialized

View Log Designer.

Click Save As.

Navicat Win 297

Edit Materialized View Log

To edit the existing materialized view log (manage its general, advance, etc)



Select the materialized view log for editing in the object pane.

Right-click and select the Design Materialized View Log from the popup menu or simply double-click the materialized view log. or

Click the Design Materialized View Log from the object pane toolbar.

Edit materialized view log properties on the appropriate tabs of the Materialized View

Log Designer.

Open Materialized View Log Table

To open a materialized view log table (manage materialized view log data)



Select the materialized view log table for opening in the object pane.

Right-click and select the Open Materialized View Log Table from the popup menu or

Click the Open Materialized View Log Table from the object pane toolbar.

Maintain Materialized View Log

To maintain a materialized view log



Select the materialized view log table for maintaining in the object pane.

Right-click and select the Maintain from the popup menu. o o o

Enable Row Movement

Disable Row Movement

Shrink Space

Delete Materialized View Log

To delete a materialized view log



Select the materialized view log for deleting in the object pane.

Right-click and select the Delete Materialized View Log from the popup menu. or

Click the Delete Materialized View Log from the object pane toolbar.

Confirm deleting in the dialog window.

Navicat Win 298

Achieve Materialized View Log Information

To achieve a materialized view log information



Select the materialized view log in the object pane.

Right-click the selected materialized view log and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 299

Oracle Materialized View Log Designer

Materialized View Log Designer is the basic Navicat tool for working with materialized view logs. It allows you to create new materialized view log and edit the existing materialized view log definition.



Editing Materialized View Log General

Materialized View Log SQL Preview

Navicat Win 300

Editing Oracle Materialized View Log General

Edit the materialized view log general properties under the General tab.

Table

The table of the materialized view log.

Tablespace

The tablespace of the materialized view log.

Logging

To specify either LOGGING or NOLOGGING to establish the logging characteristics for the materialized view log.

Cache

CACHE

The blocks retrieved for this log are placed at the most recently used end of the least recently used (LRU) list in the buffer cache when a full table scan is performed.

NOCACHE

The blocks are placed at the least recently used end of the LRU list. This is the default.

New Values

INCLUDING

To save both new and old values in the log.

EXCLUDING

To disable the recording of new values in the log.

Parallel With Degree

To determine the number of parallel threads used in the parallel operation.

Editing Package Definition

Set the physical attributes of a materialized view log.

Navicat Win 301

With

Object ID

The system-generated or user-defined object identifier of every modified row should be recorded in the materialized view log.

Primary Key

The primary key of all rows changed should be recorded in the materialized view log.

Row ID

The rowid of all rows changed should be recorded in the materialized view log.

Sequence

A sequence value providing additional ordering information should be recorded in the materialized view log.

Fields

Choose the fields whose values you want to be recorded in the materialized view log for all rows that are changed.

Navicat Win 302

Oracle Packages

Packages are encapsulated collections of related procedures, stored functions, and other program objects stored together in the database. Package bodies, specified subsequently, defines these objects. An package consists of two parts: a specification and a body.

Just simply click -> Package to open an object pane for Package. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected package.

Create Package (Package Specification)

To create a new package



Select anywhere on the object pane.

Click the New Package from the object pane toolbar. or

Right-click and select New Package from the popup menu.

Edit package properties on the appropriate tabs of the Package Designer.

Edit Package

To edit the existing package (manage its definition etc)



Select the package for editing in the object pane.

Right-click and select the Design Package from the popup menu or simply double-click the package. or

Click the Design Package from the object pane toolbar.

Edit package properties on the appropriate tabs of the Package Designer.

Delete Package

To delete a package



Select the package for deleting in the object pane.

Right-click and select the Delete Package from the popup menu. or

Click the Delete Package from the object pane toolbar.

Confirm deleting in the dialog window.

Navicat Win 303

Create Package Body (Package Body)

To create a new package body



Select the package for modifying in the object pane.

Right-click and select New Package Body from the popup menu.

Edit package body properties on the appropriate tabs of the Package Body Designer.

Edit Package Body

To edit the existing package body (manage its definition etc)



Select the package for editing in the object pane.

Right-click and select the Design Package Body from the popup menu.

Edit package body properties on the appropriate tabs of the Package Body Designer.

Delete Package Body

To delete a package body



Select the package for deleting in the object pane.

Right-click and select the Delete Package Body from the popup menu.

Confirm deleting in the dialog window.

Run Package

To run a package in the object pane



Select the package for executing in the object pane.

Click the Execute Package from the object pane toolbar. or

Right-click and select Execute Package from the popup menu.

View the returned data on the DBMS Output tab.

To run a package in the Package Designer



Create a new package/open the existing package.

Click Run.

View the returned data on the DBMS Output tab.

Navicat Win 304

Debug Package

To debug a package h



Select the package for debugging in the object pane.

Right-click and select the Debug Package from the popup menu.

Debug the package in the Debugger.

To debug a package in the Package Designer



Create a new package/open the existing package.

Click Debug.

Debug the package in the Debugger.

Maintain Package

To maintain a package



Select the package for maintaining in the object pane.

Right-click and select the Maintain from the popup menu. o o

Compile

Compile Debug

Achieve Package Information

To achieve a package information



Select the package in the object pane.

Right-click the selected package and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 305

Oracle Package Designer

Package Designer is the basic Navicat tool for working with packages. It allows you to create new package and edit the existing package definition.



Package SQL Preview

Viewing Package Result

Debugging Package

After saving the package, you can edit the Package Body. Just click Design Package

Body to open the Package Body Designer.

Navicat Win 306

Editing Oracle Package Definition

Edit the package definition under the Definition tab.

The Code Outline window displays information about the package including function, procedure, parameter, code body, etc. To show the Code Outline window, simply choose

View -> Code Outline.

Note: Available only in Full Version.

Refresh the code outline.

Show the detail view of the code outline.

Turn mouse over highlight on or off.

Expand the selected item.

Collapse the selected item.

Toggle sorting by position.

The SQL statements for creating packages are CREATE PACKAGE. In practice, it is best to use a CREATE OR REPLACE statement. The general form of these statements follows.

CREATE OR REPLACE

PACKAGE /*PACKAGE NAME*/ AS

/* TODO enter package declarations (types, exceptions, methods etc) here */

end;

Hint: To customize the view of the editor and find out more features for sql editing, see Editor

View and More Features.

Navicat Win 307

Oracle Package Body Designer

Package Body Designer is the basic Navicat tool for working with package bodies. It allows you to create new package body and edit the existing package body definition.



Editing Package Body Definition

Package Body SQL Preview

Viewing Package Result

Debugging Package

To edit the Package Specification, click Design Package Specification to open the

Package Designer.

Navicat Win 308

Editing Oracle Package Body Definition

Edit the package body definition under the Definition tab.

The Code Outline window displays information about the package body including function, procedure, parameter, code body, etc. To show the Code Outline window, simply choose

View -> Code Outline.

Note: Available only in Full Version.

Refresh the code outline.

Show the detail view of the code outline.

Turn mouse over highlight on or off.

Expand the selected item.

Collapse the selected item.

Toggle sorting by position.

The SQL statements for creating procedures are CREATE PACKAGE BODY. In practice, it is best to use a CREATE OR REPLACE statement. The general form of these statements follows.

CREATE OR REPLACE

PACKAGE BODY /*PACKAGE NAME*/ AS

....

END;

Hint: To customize the view of the editor and find out more features for sql editing, see Editor

View and More Features.

Navicat Win 309

Viewing Oracle Package Result

To run the package click Run on the toolbar. If the SQL statement is correct, the statement will be executed and, if the statement is supposed to return data, the Message and DBMS Output tabs open with the message log and data returned by the package. If an error occurs while executing the package, execution stops, the appropriate error message is displayed.

Select the function/procedure and enter the parameter(s) if the function/procedure has input parameter(s).

Navicat Win 310

Debugging Oracle Package (Available only in Full Version)

To debug the package click

Debug on the toolbar to launch the Oracle Debugger .

You can add/remove breakpoints for debugging by clicking in the grey area beside each statement.

Select the function/procedure and enter the parameter(s) if the function/procedure has input parameter(s).

Navicat Win 311

Oracle Sequences

Sequence involves creating and initializing a new special single-row table. It is usually used to generate unique identifiers for rows of a table.

Just simply click -> Sequence to open an object pane for Sequence. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected sequence.

Create Sequence

To create a new sequence



Select anywhere on the object pane.

Click the New Sequence from the object pane toolbar. or

Right-click and select New Sequence from the popup menu.

Edit sequence properties on the appropriate tabs of the Sequence Designer.

To create a new sequence with modification as one of the existing sequence



Select the sequence for modifying in the object pane.

Right-click and select the Design Sequence from the popup menu or simply double-click the sequence. or

Click the Design Sequence from the object pane toolbar.

Modify sequence properties on the appropriate tabs of the Sequence Designer.

Click Save As.

Edit Sequence

To edit the existing sequence(manage its general etc)



Select the sequence for editing in the object pane.

Right-click and select the Design Sequence from the popup menu or simply double-click the sequence. or

Click the Design Sequence from the object pane toolbar.

Edit sequence properties on the appropriate tabs of the Sequence Designer.

Navicat Win 312

Delete Sequence

To delete a sequence



Select the sequence for deleting in the object pane.

Right-click and select the Delete Sequence from the popup menu. or

Click the Delete Sequence from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Sequence Information

To achieve a sequence information



Select the sequence in the object pane.

Right-click the selected sequence and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 313

Oracle Sequence Designer

Sequence Designer is the basic Navicat tool for working with sequence. It allows you to create new sequence and edit the existing sequence properties.



Editing Sequence General

Sequence SQL Preview

Navicat Win 314

Editing Oracle Sequence General

Increment

To specify which value is added to the current sequence value to create a new value. A positive value will make an ascending sequence, a negative one a descending sequence. The default value is 1.

Start with

To specify the first sequence number to be generated.

Minimum

The minimum value a sequence can generate.

Maximum

The maximum value for the sequence.

Cache

To specify how many values of the sequence the database preallocates and keeps in memory for faster access. The minimum value for this parameter is 2. (The database caches 20 sequence numbers by default.)

No Cache

This option indicates that values of the sequence are not preallocated.

Cycled

This option allows the sequence continues to generate values after reaching either its maximum or minimum value. After an ascending sequence reaches its maximum value, it generates its minimum value. After a descending sequence reaches its minimum, it generates its maximum value.

Order

This option guarantees that sequence numbers are generated in order of request.

Navicat Win 315

Oracle Synonyms

Synonym is an alias for any table, view, materialized view, synonym, procedure, function, package, type, Java class schema object, user-defined object type, or another synonym.

Because a synonym is simply an alias, it requires no storage other than its definition in the data dictionary.

Just simply click -> Synonym to open an object pane for Synonym. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected synonym.

Create Synonym

To create a new synonym



Select anywhere on the object pane.

Click the New Synonym from the object pane toolbar. or

Right-click and select New Synonym from the popup menu.

Edit synonym properties on the appropriate tabs of the Synonym Designer.

To create a new synonym with modification as one of the existing synonym



Select the synonym for modifying in the object pane.

Right-click and select the Design Synonym from the popup menu or simply double-click the synonym. or

Click the Design Synonym from the object pane toolbar.

Modify synonym properties on the appropriate tabs of the Synonym Designer.

Click Save As.

Navicat Win 316

Edit Synonym

To edit the existing synonym(manage its general etc)



Select the synonym for editing in the object pane.

Right-click and select the Design Synonym from the popup menu or simply double-click the synonym. or

Click the Design Synonym from the object pane toolbar.

Edit synonym properties on the appropriate tabs of the Synonym Designer.

To change the name of the synonym



Select the synonym for editing in the object pane.

Right-click and select the Rename from the popup menu.

Delete Synonym

To delete a synonym



Select the synonym for deleting in the object pane.

Right-click and select the Delete Synonym from the popup menu. or

Click the Delete Synonym from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Synonym Information

To achieve a synonym information



Select the synonym in the object pane.

Right-click the selected synonym and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 317

Oracle Synonym Designer

Synonym Designer is the basic Navicat tool for working with synonym. It allows you to create new synonym and edit the existing synonym properties.



Editing Synonym General

Synonym SQL Preview

Navicat Win 318

Editing Oracle Synonym General

Object DataBase Link

A complete or partial database link to create a synonym for a schema object on a remote database where the object is located.

Object Schema

The schema in which the object resides.

Object Type

The object type.

Object

The object for which the synonym is created.

Navicat Win 319

Oracle Triggers

Triggers are similar to procedures. A trigger stored in the database can include SQL and

PL/SQL or Java statements to run as a unit and can invoke procedures.

Setting Advanced Trigger Properties

Just simply click -> Trigger to open an object pane for Trigger. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected trigger.

Create Trigger

To create a new trigger



Select anywhere on the object pane.

Click the New Trigger from the object pane toolbar. or

Right-click and select New Trigger from the popup menu.

Edit trigger properties on the appropriate tabs of the Trigger Designer.

To create a new trigger with modification as one of the existing trigger



Select the trigger for modifying in the object pane.

Right-click and select the Design Trigger from the popup menu or simply double-click the trigger. or

Click the Design Trigger from the object pane toolbar.

Modify trigger properties on the appropriate tabs of the Trigger Designer.

Click Save As.

Navicat Win 320

Edit Trigger

To edit the existing trigger (manage its general, advance, etc)



Select the trigger for editing in the object pane.

Right-click and select the Design Trigger from the popup menu or simply double-click the trigger. or

Click the Design Trigger from the object pane toolbar.

Edit trigger properties on the appropriate tabs of the Trigger Designer.

To change the name of the trigger



Select the trigger for editing in the object pane.

Right-click and select the Rename from the popup menu.

Maintain Trigger

To maintain a trigger



Select the trigger for maintaining in the object pane.

Right-click and select the Maintain from the popup menu. o o

Enable

Disable o o

Compile

Compile for Debug

Delete Trigger

To delete a trigger



Select the trigger for deleting in the object pane.

Right-click and select the Delete Trigger from the popup menu. or

Click the Delete Trigger from the object pane toolbar.

Confirm deleting in the dialog window.

Navicat Win 321

Achieve Trigger Information

To achieve a trigger information



Select the trigger in the object pane.

Right-click the selected trigger and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 322

Oracle Trigger Designer

Trigger Designer is the basic Navicat tool for working with triggers. It allows you to create new trigger and edit the existing trigger definition.



Editing Trigger General

Editing Trigger Definition

Trigger SQL Preview

Navicat Win 323

Editing Oracle Trigger General

TABLE

To define the trigger on the selected table.

VIEW

To define the trigger on the selected view.

SCHEMA

To define the trigger on the selected schema.

DATABASE

To define the trigger on the entire database.

Navicat Win 324

Oracle Table Trigger

Trigger Type

Choose the type of trigger: TABLE, VIEW, SCHEMA and DATABASE

Enable

An enabled trigger runs its trigger action if a triggering statement is issued and the trigger restriction (if any) evaluates to true.

Table Schema

The table schema of the trigger.

Table name

The table you wish to create the trigger.

Compound

A compound trigger is a single trigger on a table that allows you to specify actions for each of four timing points:

Timing Point

Before the triggering statement executes

Section

BEFORE STATEMENT

After the triggering statement executes AFTER STATEMENT

Before each row that the triggering statement affects BEFORE EACH ROW

After each row that the triggering statement affects AFTER EACH ROW

Note: Support from Oracle 11g or later and you can edit the SQL in Trigger Definition.

Fire

When defining a trigger, you can specify the trigger timing - whether the trigger action is to be run BEFORE or AFTER the triggering statement.

For Each

Oracle Database fires a ROW trigger once for each row that is affected by the triggering statement and fires a STATEMENT trigger only once when the triggering statement is issued if the optional trigger constraint is met.

When

To specify the trigger condition, which is a SQL condition that must be satisfied for the database to fire the trigger.

Navicat Win 325

On Event

It indicates the kind of statement that activates the trigger.

Insert

The trigger is activated whenever adding a row to a table or adds an element to a nested table.

Delete

The trigger is activated whenever removing a row from the table or removes an element from a nested table.

Update

The trigger is activated whenever changing a value in one of the fields selected in

Update Of Fields.

Navicat Win 326

Oracle View Trigger

Trigger Type

Choose the type of trigger: TABLE, VIEW, SCHEMA and DATABASE

Enable

An enabled trigger runs its trigger action if a triggering statement is issued and the trigger restriction (if any) evaluates to true.

Table Schema

The table schema of the trigger.

Table name

The table you wish to create the trigger.

Nested Table Field

To select the nested table field.

Compound

To specify the Instead Of Trigger.

Note: Support from Oracle 11g or later and you can edit the SQL in Trigger Definition.

On Event

It indicates the kind of statement that activates the trigger.

Insert

The trigger is activated whenever adding a row to a table or adds an element to a nested table.

Delete

The trigger is activated whenever removing a row from the table or removes an element from a nested table.

Update

The trigger is activated whenever changing a value in a row.

Navicat Win 327

Oracle Schema Trigger

Trigger Type

Choose the type of trigger: TABLE, VIEW, SCHEMA and DATABASE

Enable

An enabled trigger runs its trigger action if a triggering statement is issued and the trigger restriction (if any) evaluates to true.

Table Schema

The table schema of the trigger.

Fire

When defining a trigger, you can specify the trigger timing - whether the trigger action is to be run BEFORE or AFTER the triggering statement.

When

To specify the trigger condition, which is a SQL condition that must be satisfied for the database to fire the trigger.

Events

The kind of statement that activates the trigger.

Navicat Win 328

Oracle Database Trigger

Trigger Type

Choose the type of trigger: TABLE, VIEW, SCHEMA and DATABASE

Enable

An enabled trigger runs its trigger action if a triggering statement is issued and the trigger restriction (if any) evaluates to true.

Fire

When defining a trigger, you can specify the trigger timing - whether the trigger action is to be run BEFORE or AFTER the triggering statement.

When

To specify the trigger condition, which is a SQL condition that must be satisfied for the database to fire the trigger.

Events

The kind of statement that activates the trigger.

Navicat Win 329

Setting Advanced Oracle Trigger Properties

The Advanced tab is available when the trigger type is TABLE or VIEW.

Referencing Old

Correlation names of the old nested table.

Referencing New

Correlation names of the new nested table.

Referencing Parent

Correlation names of the parent table.

Follows

To indicate that the trigger should fire after the specified triggers.

Use the Schema dropdown list to select the schema name and Trigger dropdown list to select the trigger.

To add triggers, just simply press plus button. To remove triggers, select a trigger and press the cross button.

Note: Support from Oracle 11g or later.

Navicat Win 330

Editing Oracle Trigger Definition

The Definition tab allows you to edit valid SQL or procedure statements in the trigger definition inside BEGIN and END.

Navicat Win 331

Oracle Types

Type is an user-defined datatype that model the structure and behavior of the data in an application. An object type consists of two parts: a specification and a body. The type body always depends on its type specification. A collection type is a named varying array (varray) or a nested table type.

Just simply click -> Type to open an object pane for Type. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected type.

Create Object Type (Object Type Specification)

To create a new object type



Select anywhere on the object pane.

Click the New Object Type from the object pane toolbar. or

Right-click and select New Object Type from the popup menu.

Edit object type properties on the appropriate tabs of the Object Type Designer.

Edit Object Type

To edit the existing object type (manage its definition etc)



Select the object type for editing in the object pane.

Right-click and select the Design Type from the popup menu or simply double-click the object type. or

Click the Design Type from the object pane toolbar.

Edit object type properties on the appropriate tabs of the Object Type Designer.

Navicat Win 332

Delete Object Type

To delete an object type



Select the object type for deleting in the object pane.

Right-click and select the Delete Type from the popup menu. or

Click the Delete Type from the object pane toolbar.

Confirm deleting in the dialog window.

Create Type Body (Object Type Body)

To create a new type body



Select the object type for modifying in the object pane.

Right-click and select New Type Body from the popup menu.

Edit type body properties on the appropriate tabs of the Type Body Designer.

Edit Type Body

To edit the existing type body (manage its definition etc)



Select the object type for editing in the object pane.

Right-click and select the Design Type Body from the popup menu.

Edit type body properties on the appropriate tabs of the Type Body Designer.

Delete Type Body

To delete a type body



Select the object type for deleting in the object pane.

Right-click and select the Delete Type Body from the popup menu.

Confirm deleting in the dialog window.

Navicat Win 333

Create Collection Type

To create a new collection type



Select anywhere on the object pane.

Click the New Collection Type from the object pane toolbar. or

Right-click and select New Collection Type from the popup menu.

Edit collection type properties on the appropriate tabs of the Collection Type Designer.

To create a new collection type with modification as one of the existing collection type



Select the collection for modifying in the object pane.

Right-click and select the Design Type from the popup menu or simply double-click the collection type. or

Click the Design Type from the object pane toolbar.

Modify collection type properties on the appropriate tabs of the Collection Type

Designer.

Click Save As.

Edit Collection Type

To edit the existing collection type(manage its general etc)



Select the collection type for editing in the object pane.

Right-click and select the Design Type from the popup menu or simply double-click the collection type. or

Click the Design Type from the object pane toolbar.

Edit collection type properties on the appropriate tabs of the Collection Type Designer.

Delete Collection Type

To delete a collection type



Select the collection type for deleting in the object pane.

Right-click and select the Delete Type from the popup menu. or

Click the Delete Type from the object pane toolbar.

Confirm deleting in the dialog window.

Navicat Win 334

Maintain Type

To maintain a type



Select the type for maintaining in the object pane.

Right-click and select the Maintain from the popup menu. o o

Compile

Compile for Debug

Achieve Type Information

To achieve a type information



Select the type in the object pane.

Right-click the selected type and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 335

Oracle Object Type Designer

Object Type Designer is the basic Navicat tool for working with object types. It allows you to create new object type and edit the existing object type definition.



Editing Object Type Definition

Object Type SQL Preview

After saving the object type, you can edit the Object Type Body. Just click Design Object

Type Body to open the Type Body Designer.

Navicat Win 336

Editing Oracle Object Type Definition

Edit the object type definition under the Definition tab.

The Code Outline window displays information about the object type including declaration, etc. To show the Code Outline window, simply choose View -> Code Outline.

Note: Available only in Full Version.

Refresh the code outline.

Show the detail view of the code outline.

Turn mouse over highlight on or off.

Expand the selected item.

Collapse the selected item.

Toggle sorting by position.

The SQL statements for creating object types are CREATE TYPE. In practice, it is best to use a CREATE OR REPLACE statement. The general form of these statements follows.

CREATE OR REPLACE

TYPE /*TYPE NAME*/ AS OBJECT (

/* TODO enter type specification (methods, attributes etc) here */

)

Hint: To customize the view of the editor and find out more features for sql editing, see Editor

View and More Features.

Navicat Win 337

Oracle Type Body Designer

Type Body Designer is the basic Navicat tool for working with object type bodies. It allows you to create new type body and edit the existing type body definition.



Editing Type Body Definition

Type Body SQL Preview

To edit the Object Type Specification, click Design Object Type Specification to open the Object Type Designer.

Navicat Win 338

Editing Oracle Type Body Definition

Edit the type body definition under the Definition tab.

The Code Outline window displays information about the type body including declaration, etc. To show the Code Outline window, simply choose View -> Code Outline.

Note: Available only in Full Version.

Refresh the code outline.

Show the detail view of the code outline.

Turn mouse over highlight on or off.

Expand the selected item.

Collapse the selected item.

Toggle sorting by position.

The SQL statements for creating type bodies are CREATE TYPE BODY. In practice, it is best to use a CREATE OR REPLACE statement. The general form of these statements follows.

CREATE OR REPLACE

TYPE BODY /*TYPE NAME*/ AS

....

END;

Hint: To customize the view of the editor and find out more features for sql editing, see Editor

View and More Features.

Navicat Win 339

Oracle Collection Type Designer

Collection Type Designer is the basic Navicat tool for working with collection types. It allows you to create new collection type and edit the existing collection type definition.



Editing Collection Type General

Collection Type SQL Preview

Navicat Win 340

Editing Oracle Collection Type General

Nested table

Create a nested table type.

VArray

Create a varray type.

Array Size

Determine the array size of the varray type.

Data Type

Select the Oracle Database built-in datatype or user-defined type of the attribute.

Data Type Parameter

Determine the corresponding data type parameters.

Navicat Win 341

Oracle XML Schemas

XML Schema is a schema definition language written in XML. It can be used to describe the structure and various other semantics of conforming instance documents.

Just simply click -> XML Schema to open an object pane for XML Schema. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected XML Schema.

Create XML Schema

To create a new XML Schema



Select anywhere on the object pane.

Click the New XML Schema from the object pane toolbar. or

Right-click and select New XML Schema from the popup menu.

Edit XML Schema properties on the appropriate tabs of the XML Schema Designer.

Maintain XML Schema

To maintain an XML Schema



Select the XML Schema for maintaining in the object pane.

Right-click and select the Maintain from the popup menu. o o

Compile

Purge

Delete XML Schema

To delete an XML Schema



Select the XML Schema for deleting in the object pane.

Right-click and select the Delete XML Schema from the popup menu. or

Click the Delete XML Schema from the object pane toolbar.

Confirm deleting in the dialog window.

Navicat Win 342

Achieve XML Schema Information

To achieve an XML Schema information



Select the XML Schema in the object pane.

Right-click the selected XML Schema and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 343

Oracle XML Schema Designer

XML Schema Designer is the basic Navicat tool for working with XML Schemas. It allows you to create new XML Schema.



Editing XML Schema Doc

Setting Advanced XML Schema Properties

XML Schema SQL Preview

Navicat Win 344

Editing Oracle XML Schema Doc

Enter a valid XML schema document under the Schema Doc tab. The general form follows.

<?xml version="1.0" encoding="UTF-8"?>

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

</xsd:schema>

Navicat Win 345

Setting Advanced Oracle XML Schema Properties

Local

Check this to register as local schemas.

Force on schema registration

Check this to ignore errors generated during schema evolution.

Generate

Object Types

Check this to enable the schema compiler to generate object types.

Java Beans

Check this to enable the schema compiler to generate Java beans.

Default Tables

Check this to enable the schema compiler to generate default tables.

Options

REGISTER_NODOCID

Check this to prevent the creation of this column if the user wishes to optimize on storage.

REGISTER_BINARYXML

Check this to register the schema for Binary XML.

REGISTER_NT_AS_IOT

Check this to store nested tables created during schema registration as index organized tables.

REGISTER_AUTO_OOL

Check this to automatically move large types out of line.

Enable Hierarchy

ENABLE_HIERARCHY_NONE

Enable hierarchy will not be called on any tables created while registering that schema.

Navicat Win 346

ENABLE_HIERARCHY_CONTENTS

Enable hierarchy will be called for all tables created during schema registration with hierarchy_type as DBMS_XDBZ.ENABLE_CONTENTS.

ENABLE_HIERARCHY_RESMETADATA

Enable hierarchy will be called on all tables created during schema registration with hierarchy_type as DBMS_XDBZ.ENABLE_RESMETADATA.

Navicat Win 347

Oracle Recycle Bin

Recycle bin is actually a data dictionary table containing information about dropped objects.

Dropped tables and any associated objects such as indexes, constraints, nested tables, and the likes are not removed and still occupy space. They continue to count against user space quotas, until specifically purged from the recycle bin or the unlikely situation where they must be purged by the database because of tablespace space constraints.

Just simply click -> Recycle Bin to open an object pane for Recycle Bin. A right-click displays the popup menu or using the object pane toolbar, allowing you to flashback tables or purge the deleted objects.

Restore tables

To restore table from recycle bin



Choose a table in recycle bin.

Click the Flashback Table from the object pane toolbar. or

Right-click and select Flashback Table from the popup menu.

Purge Objects

To remove an object in the recycle bin



Select an object for purging in the object pane.

Right-click and select the Purge Object from the popup menu. or

Click the Purge Object from the object pane toolbar.

Confirm deleting in the dialog window.

To remove all objects in the recycle bin



Right-click and select the Purge Recycle Bin from the popup menu.

Confirm deleting in the dialog window.

Navicat Win 348

To remove all objects in the recycle bin of every user



Right-click and select the Purge DBA Recycle Bin from the popup menu.

Confirm deleting in the dialog window.

Achieve Recycle Bin Object Information

To achieve an object information in recycle bin



Select the object in the object pane.

Right-click the selected object and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 349

Oracle Directories

A directory object specifies an alias for a directory on the server file system where external binary file LOBs (BFILEs) and external table data are located. All directories are created in a single namespace and are not owned by an individual schema.

Just simply click -> Directory to open an object pane for Directory. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected directory.

Create Directory

To create a new directory



Select anywhere on the object pane.

Click the New Directory from the object pane toolbar. or

Right-click and select New Directory from the popup menu.

Edit directory properties on the appropriate tabs of the Directory Designer.

To create a new directory with modification as one of the existing directory



Select the directory for modifying in the object pane.

Right-click and select the Design Directory from the popup menu or simply double-click the directory. or

Click the Design Directory from the object pane toolbar.

Modify directory properties on the appropriate tabs of the Directory Designer.

Click Save As.

Edit Directory

To edit the existing directory(manage its general etc)



Select the directory for editing in the object pane.

Right-click and select the Design Directory from the popup menu or simply double-click the directory. or

Click the Design Directory from the object pane toolbar.

Edit directory properties on the appropriate tabs of the Directory Designer.

Navicat Win 350

Delete Directory

To delete a directory



Select the directory for deleting in the object pane.

Right-click and select the Delete Directory from the popup menu. or

Click the Delete Directory from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Directory Information

To achieve a directory information



Select the directory in the object pane.

Right-click the selected directory and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 351

Oracle Directory Designer

Directory Designer is the basic Navicat tool for working with directories. It allows you to create new directory and edit the existing directory definition.



Editing Directory General

Directory SQL Preview

Navicat Win 352

Editing Oracle Directory General

Edit the directory general properties under the General tab.

Directory Path

Specify the full path name of the operating system directory of the server where the files are located. The path name is case sensitive

Navicat Win 353

Oracle Tablespaces

Tablespaces are the allocation of space in the database that can contain schema objects.

Just simply click -> Tablespace to open an object pane for Tablespace. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected tablespace.

Create Tablespace

To create a new tablespace



Select anywhere on the object pane.

Click the New Tablespace from the object pane toolbar. or

Right-click and select New Tablespace from the popup menu.

Edit tablespace properties on the appropriate tabs of the Tablespace Designer.

To create a new tablespace with modification as one of the existing tablespace



Select the tablespace for modifying in the object pane.

Right-click and select the Design Tablespace from the popup menu or simply double-click the tablespace. or

Click the Design Tablespace from the object pane toolbar.

Modify tablespace properties on the appropriate tabs of the Tablespace Designer.

Click Save As.

Edit Tablespace

To edit the existing tablespace (manage its properties etc)



Select the tablespace for editing in the object pane.

Right-click and select the Design Tablespace from the popup menu or simply double-click the tablespace. or

Click the Design Tablespace from the object pane toolbar.

Edit tablespace properties on the appropriate tabs of the Tablespace Designer.

Navicat Win 354

To change the name of the tablespace



Select the tablespace for editing in the object pane.

Right-click and select the Rename from the popup menu.

Maintain Tablespace

To maintain a tablespace



Select the tablespace for maintaining in the object pane.

Right-click and select the Maintain from the popup menu. o o

[Read Only]

Read Write o o

Online

Offline



Normal

Temporary o o

 Immediate

Coalesce

Shrink Space

Delete Tablespace

To delete a tablespace



Select the tablespace for deleting in the object pane.

Right-click and select the Delete Tablespace from the popup menu. or

Click the Delete Tablespace from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Tablespace Information

To achieve a tablespace information



Select the tablespace in the object pane.

Right-click the selected tablespace and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 355

Oracle Tablespace Designer

Tablespace Designer is the basic Navicat tool for working with tablespaces. It allows you to create new tablespace and edit the existing tablespace properties.



Editing Tablespace General

Editing Tablespace Storage

Setting Advanced Tablespace Properties

Tablespace SQL Preview

Navicat Win 356

Editing Oracle Tablespace General

Tablespace Type

PERMANENT

A permanent tablespace contains persistent schema objects. Objects in permanent tablespaces are stored in datafiles.

TEMPORARY

A temporary tablespace contains schema objects only for the duration of a session.

Objects in temporary tablespaces are stored in tempfiles.

UNDO

An undo tablespace is a type of permanent tablespace used by Oracle Database to manage undo data if you are running your database in automatic undo management mode.

Data File

Use the Name and Size edit box to set the datafile / tempfile name and size.

The Unit drop-down list defines the unit of the size of the datafile / tempfile. Specify the maximum disk space allowed for automatic extension of the datafile. Use the dropdown list K, M, G, T, P or E to specify the size in kilobytes, megabytes, gigabytes, terabytes, petabytes, or exabytes. If you do not specify any of the abbreviations, then the size is interpreted as bytes.

Reuse

To allow Oracle to reuse an existing file.

Path

Specify the path of the datafile / tempfile.

Auto Extend

To ON (enable) or OFF (disable) the automatic extension of a new or existing datafile or tempfile.

Navicat Win 357

Next Size

Specify the size in bytes of the next increment of disk space to be allocated automatically when more extents are required. The default is the size of one data block. Use the dropdown list K, M, G, T, P or E to specify the size in kilobytes, megabytes, gigabytes, terabytes, petabytes, or exabytes. If you do not specify any of the abbreviations, then the size is interpreted as bytes.

Unlimited Max

Unlimited disk space that Oracle can allocate to the datafile or tempfile.

Max Size

Specify the maximum disk space allowed for automatic extension of the datafile. Use the dropdown list K, M, G, T, P or E to specify the size in kilobytes, megabytes, gigabytes, terabytes, petabytes, or exabytes. If you do not specify any of the abbreviations, then the size is interpreted as bytes.

Navicat Win 358

Editing Oracle Tablespace Storage

File Type

BIGFILE

A bigfile tablespace contains only one datafile or tempfile, which can contain up to approximately 4 billion (2 32 ) blocks. The maximum size of the single datafile or tempfile is 128 terabytes (TB) for a tablespace with 32K blocks and 32TB for a tablespace with 8K blocks.

SMALLFILE

A smallfile tablespace is a traditional Oracle tablespace, which can contain 1022 datafiles or tempfiles, each of which can contain up to approximately 4 million (2 22 ) blocks.

Min Extent Size

The minimum size of an extent in the tablespace. Use the dropdown list K, M, G, T, P or E to specify the size in kilobytes, megabytes, gigabytes, terabytes, petabytes, or exabytes. If you do not specify any of the abbreviations, then the size is interpreted as bytes.

Block Size

The block size for the tablespace.

Default Storage Options

Set the default storage characteristics for objects created in the tablespace.

Table Compression

Use the dropdown list to select the type of compressing data segments to reduce disk use.

Manual Segment Management

To manage the free space of segments in the tablespace using free lists.

Extent Management

To specify how the extents of the tablespace will be managed.

Extent Management

DICTIONARY

Extent management by the data dictionary.

Navicat Win 359

LOCAL

Extent management by the bitmaps.

Local Extent

AUTOALLOCATE

The tablespace is system managed.

UNIFORM

The tablespace is managed with uniform extents of size.

Uniform Size

The size of uniform extent. The default size is 1 megabyte. Use the dropdown list K, M,

G, T, P or E to specify the size in kilobytes, megabytes, gigabytes, terabytes, petabytes, or exabytes. If you do not specify any of the abbreviations, then the size is interpreted as bytes.

Navicat Win 360

Setting Advanced Oracle Tablespace Properties

Logging

LOGGING

Log all objects within the tablspace in the redo log file.

NOLOGGING

No operations are logged.

Force Logging

Oracle Database will log all changes to all objects in the tablespace except changes to temporary segments, overriding any NOLOGGING setting for individual objects.

Offline

The tablespace is unavailable immediately (offline) after creation.

Retention Guarantee

Oracle Database should preserve unexpired undo data in all undo segments of tablespace even if doing so forces the failure of ongoing operations that need undo space in those segments.

Tablespace Group

To determine whether tablespace is a member of a tablespace group.

Flashback

Oracle Database will save Flashback log data for this tablespace and the tablespace can participate in a FLASHBACK DATABASE operation.

OFF

Oracle Database will not save any Flashback log data for this tablespace.

Encryption

Use Encryption

Enable the encryption properties of the tablespace.

Algorithm

To select the encryption algorithm.

Navicat Win 361

Oracle Public Database Links

Public database Link is a database link created by a DBA on a local database that is accessible to all users on that database.

See Database Link for details.

Navicat Win 362

Oracle Public Synonyms

Public synonym is a synonym owned by the special user group named PUBLIC and every user in a database can access it.

See Synonyms for details.

Navicat Win 363

PostgreSQL Database Object Management

The following list contains the most common PostgreSQL database objects supported by

Navicat.



Navicat Win 364

PostgreSQL Schemas

A schema is essentially a namespace: it contains named objects (tables, data types, functions, and operators) whose names may duplicate those of other objects existing in other schemas.

The schema name must be distinct from any existing schema name in the current database.

Create Schema

To create a new schema



Right-click the database in the navigation pane and choose New Schema.... or

Right-click any existing schema and choose New Schema....

Edit schema properties on the appropriate tabs of the Schema Designer.

Edit Schema

To edit the existing schema(manage its general etc)



Right-click the schema in the navigation pane and choose Schema Properties....

Edit schema properties on the appropriate tabs of the Schema Designer.

Open Schema

To open a schema which shows in the navigation pane



Double-click the schema to open in the navigation pane. or

Right-click the schema and choose Open Schema.

Close Schema

To close a schema

 Right-click the schema in the navigation pane and choose Close Schema.

Navicat Win 365

Delete Schema

To delete a schema



Right-click the schema in the navigation pane and choose Delete Schema.

Confirm deleting in the dialog window.

Navicat Win 366

PostgreSQL Schema Designer

Schema Designer is the basic Navicat tool for working with schema. It allows you to create new schema and edit the existing schema properties.



Editing Schema General

Editing Schema Comment

Navicat Win 367

Editing PostgreSQL Schema General

Schema Name

The name of a schema to be created. The name cannot begin with pg_, as such names are reserved for system schemas.

Owner

The name of the user who will own the schema. If omitted, defaults to the user executing the command.

Navicat Win 368

PostgreSQL Tables

Relational databases use tables to store data. All operations on data are done on the tables themselves or produce another tables as the result. A table is a set of rows and columns, and their intersections are fields. From a general perspective, columns within a table describe the name and type of data that will be found by row for that column's fields. Rows within a table represent records composed of fields that are described from left to right by their corresponding column's name and type. Each field in a row is implicitly correlated with each other field in that row.

Just simply click to open an object pane for Table. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit, open and delete the selected table.

Create Table

To create a new table



Select anywhere on the object pane.

Click the New Table from the object pane toolbar. or

Right-click and select New Table from the popup menu.

Edit table properties and fields on the appropriate tabs of the Table Designer.

Hint: To create new table you can also right-click the Tables node of the navigation pane and select the New Table from the popup menu.

To create a new table with the same properties as one of the existing tables has (using popup menu)

Apply to: current database {same connection}



Select the table(s) for copying in the navigation pane/object pane.

Right-click and select the Duplicate Table from the popup menu.

The newly created table(s) will be named as "tablename_copy".

Navicat Win 369

To create a new table with the same properties as one of the existing tables has (using drag and drop method)

Apply to: current database {same connection}



Select the table(s) for copying in the navigation pane/object pane.

Right-click and drag the chosen table(s) to the target location.

Select one of the following options: o

Copy here (Structure and Data) o o

Copy here (Structure only)

Move here o

Cancel

The newly created table(s) will be named as "tablename_copy"

Apply to: different database {same connection} different database {different connection (same or cross server type)} (Data Transfer tool will be activated)



Select the table(s) for copying in the object pane.

Drag and drop the chosen table(s) to the target database.

Select one of the following options: o o o

Copy here (Structure and Data)

Copy here (Structure only)

Cancel

To create a new table with modification as one of the existing tables



Select the table for modifying in the navigation pane/object pane.

Right-click and select the Design Table from the popup menu. or

Click the Design Table from the object pane toolbar.

Modify table properties and fields on the appropriate tabs of the Table Designer.

Click Save As.

Navicat Win 370

Create Table Shortcut

To create a table shortcut



Select the table for editing in the navigation pane/object pane.

Right-click and select Create Open Table Shortcut... from the popup menu.

Define the location you wish your shortcut to be saved.

Note: This option is used to provide a convenient way for you to open your table for entering data directly (Grid View/Form View) without activating the main Navicat.

Edit Table

To edit the existing table (manage its fields, indexes, foreign keys and triggers etc)



Select the table for editing in the navigation pane/object pane.

Right-click and select the Design Table from the popup menu. or

Click the Design Table from the object pane toolbar.

Edit table properties and fields on the appropriate tabs of the Table Designer.

To change the name of the table



Select the table for editing in the navigation pane/object pane.

Right-click and select the Rename from the popup menu.

Open Table (manage table data)

To open a table



Select the table for opening in the navigation pane/object pane.

Right-click and select the Open Table from the popup menu or simply double-click the table. or

Click the Open Table from the object pane toolbar.

Note: This option is only applied if you do wish Navicat loads all your images while opening the table. To open the graphical table with faster performance, use Open

Table (Quick) below.

Navicat Win 371

To open a table with graphical fields



Select the table for opening in the navigation pane/object pane.

Right-click and select the Open Table (Quick) from the popup menu.

Note: Faster performance for opening the graphical table, as BLOB fields (images) will not be loaded until you click on the cell.

Empty Table

To empty a table



Select the table in the navigation pane/object pane.

Right-click the selected table and choose Empty Table from the popup menu.

Truncate Table

To truncate a table



Select the table in the navigation pane/object pane.

Right-click the selected table and choose Truncate Table from the popup menu.

Delete Table

To delete a table



Select the table for deleting in the navigation pane/object pane.

Right-click and select the Delete Table from the popup menu. or

Click the Delete Table from the object pane toolbar.

Confirm deleting in the dialog window.

Navicat Win 372

Achieve Table Information

To achieve a table information



Select the table in the object pane.

Right-click the selected table and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 373

PostgreSQL Table Designer

Table Designer is the basic Navicat tool for working with tables. It allows you to create, edit and drop table's fields, indexes, foreign keys, and much more.



Managing Table Excludes

Managing Table Rules

Managing Table Comment

Table SQL Preview

Navicat Win 374

PostgreSQL Table Fields

Table fields are managed on the Fields tab of the Table Designer. Just simply click a field for editing. A right-click displays the popup menu or using the field toolbar, allowing you to create new and drop the selected field.

Add Field

To add a field to the table



Open the table in the Table Designer.

Open the Fields tab.

Right-click and select the Add Field from the popup menu or click the Add Field from the toolbar.

Edit field properties.

To add a new field with modification as one of the existing fields



Open the table in the Table Designer.

Open the Fields tab.

Select field.

Right-click and select the Duplicate Field from the popup menu.

Edit field properties.

Edit Field

To edit the table field



Open the table in the Table Designer.

Open the Fields tab.

Simply click on the field to edit.

Navicat Win 375

Delete Field

To delete the table field



Open the table in the Table Designer.

Open the Fields tab.

Right-click and select the Delete Field from the popup menu or click the Delete

Field from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 376

Setting PostgreSQL Table Field Properties

Aliases int8 serial8

Name

The Name is a descriptive identifier for a field that can be up to 63 bytes long. The names should be descriptive enough that anyone can easily identify them when viewing or editing records. For example, LastName, FirstName, StreetAddress, or HomePhone.

Use the Name edit box to set the field name. Note that the name of the field must be unique among all the field names in the table.

Type

After you name a field, you choose a data type for the data to be contained in the field. When you choose a field's data type, you are deciding:



 What kind of values to allow in the field. You cannot store text in field with the

Numeric data type.

How much storage space PostgreSQL is to set aside for the data in that field.

What types of operations can be performed on the values in that field.

The Type dropdown list defines the type of the field data.

The following table shows the built-in general-purpose data types for PostgreSQL 8.3. Most of the alternative names listed in the "Aliases" column are the names used internally by

PostgreSQL for historical reasons.

Note: Some built-in general-purpose data types are not applicable for PostgreSQL 8.2 or earlier versions.

Name bigint bigserial bit [ (n) ]

Description signed eight-byte integer autoincrementing eight-byte integer fixed-length bit string

Navicat Win 377

Navicat Win bit varying [ (n) ] varbit boolean bool variable-length bit string logical Boolean (true/false) box bytea character varying

[ (n) ] rectangular box in the plane binary data ("byte array") varchar [ (n) ] variable-length character string character [ (n) ] char [ (n) ] fixed-length character string cidr circle date double precision float8

IPv4 or IPv6 network address circle in the plane calendar date (year, month, day) double precision floating-point number inet integer int, int4

IPv4 or IPv6 host address signed four-byte integer interval [ (p) ] time span line infinite line in the plane lseg macaddr line segment in the plane

MAC address money currency amount numeric [ (p, s) ] decimal [ (p, s) ] exact numeric of selectable precision path point polygon real smallint serial text time [ (p) ]

[ without time zone ] float4 int2 serial4 time [ (p) ] with time zone timestamp [ (p) ]

[ without time zone ] timetz timestamp [ (p) ] with time zone timestamptz geometric path in the plane geometric point in the plane closed geometric path in the plane single precision floating-point number signed two-byte integer autoincrementing four-byte integer variable-length character string time of day time of day, including time zone date and time date and time, including time zone

378

tsquery tsvector txid_snapshot uuid xml text search query text search document user-level transaction ID snapshot universally unique identifier

XML data

Length and Decimals

Use the Length edit box to define the length of the field and use Decimals edit box to define the number of digits after the decimal point (the scale) for Floating Point data type.

Note: Be careful when shortening the field length as losing data might be caused.

Allow Null

Allow the NULL values for the field.

Primary Key

A Primary Key is a single field or combination of fields that uniquely defines a record. None of the fields that are part of the primary key can contain a null value.

Primary Key Name

Right-click and select Primary Key Name from the popup menu to enter the primary key constraint name.

Fill Factor

Right-click and select Fill Factor from the popup menu to enter the storage parameter. The fillfactor for a table is a percentage between 10 and 100.

Navicat Win 379

Setting Other PostgreSQL Table Field Properties

To set the default value for the field use the Default edit box.

To set any optional text describing the current field use the Comment edit box.

To set the dimensions of array specifiers use the Dimensions edit box.

For Domain and Type data types:

Object Schema

Set the object schema for the field.

Object Type

Set the object type for the field.

Navicat Win 380

PostgreSQL Table Indexes

Indexes are primarily used to enhance database performance (though inappropriate use can result in slower performance).

An index field can be an expression computed from the values of one or more columns of the table row. This feature can be used to obtain fast access to data based on some transformation of the basic data.

Add Index

To add a table index



Open the table in the Table Designer.

Open the Indexes tab.

Right-click and select the Add Index from the popup menu or click the Add

Index from the toolbar.

Edit index properties.

Edit Index

To edit a table index



Open the table in the Table Designer.

Open the Indexes tab.

Just simply click/double-click on the index to edit.

Delete Index

To delete a table index



Open the table in the Table Designer.

Open the Indexes tab.

Right-click on the index to delete and select the Delete Index from the popup menu or click the Delete Index from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 381

Setting PostgreSQL Table Index Properties

Use the Name edit box to set the index name. No schema name can be included here; the index is always created in the same schema as its parent table.

To include field(s) in the index, just simply double-click the Fields field or click to open the editor for editing.

Note: Some of field types do not allow indexing by several fields.

The Index method dropdown list defines the type of the table index. PostgreSQL provides the index methods B-tree, R-tree, hash, and GiST. The B-tree index method is an implementation of Lehman-Yao high-concurrency B-trees. The R-tree index method implements standard R-trees using Guttman's quadratic split algorithm. The hash index method is an implementation of Litwin's linear hashing. Users can also define their own index methods, but that is fairly complicated.

Unique

Makes index unique, causes the system to check for duplicate values in the table when the index is created (if data already exist) and each time data is added.

Clustered

CLUSTER instructs PostgreSQL to cluster the table specified by tablename based on the index specified by indexname. The index must already have been defined on tablename.

When a table is clustered, PostgreSQL remembers on which index it was clustered. The form

CLUSTER tablename reclusters the table on the same index that it was clustered before.

Tablespace

The tablespace in which to create the index.

Constraints

If you wish to create partial index, enter constraint condition in this edit box. A partial index is an index that contains entries for only a portion of a table, usually a portion that is more useful for indexing than the rest of the table.

The Comment edit box defines the comment for the index..

Navicat Win 382

PostgreSQL Table Foreign Keys

Add Foreign Key

To add a foreign key



Open the table in the Table Designer.

Open the Foreign Keys tab.

Right-click and select the Add Foreign Key from the popup menu or click the

Add Foreign Key from the toolbar.

Edit foreign key properties.

Edit Foreign Key

To edit a foreign key



Open the table in the Table Designer.

Open the Foreign Keys tab.

Just simply click/double-click on the foreign key to edit.

Delete Foreign Key

To delete a foreign key



Open the table in the Table Designer.

Open the Foreign Keys tab.

Right-click on the foreign key to delete and select the Delete Foreign Key from the popup menu or click the Delete Foreign Key from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 383

Setting PostgreSQL Table Foreign Key Properties

Use the Name edit box to enter a name for the new key and then select a table field to include in the key from the Fields group.

Use the Reference Schema and Reference Table dropdown lists to select a foreign schema and table respectively.

To include field(s) to the key, just simply double-click the Fields/Reference Fields field or click to open the editor(s) for editing.

The On Delete and On Update dropdown list define the type of the actions to be taken.

Restrict

Produce an error indicating that the deletion or update would create a foreign key constraint violation. This is the same as NO ACTION except that the check is not deferrable.

No Action

Produce an error indicating that the deletion or update would create a foreign key constraint violation. If the constraint is deferred, this error will be produced at constraint check time if there still exist any referencing rows. This is the default action.

Cascade

Delete any rows referencing the deleted row, or update the value of the referencing column to the new value of the referenced column, respectively.

Set Null

Set the referencing column(s) to null.

Set Default

Set the referencing column(s) to their default values.

Navicat Win 384

PostgreSQL Table Uniques

Unique constraints ensure that the data contained in a column or a group of columns is unique with respect to all the rows in the table.

Uniques are managed on the Uniques tab of the Table Designer. Just simply click/double-click an unique field for editing. Using the unique toolbar, allowing you to create new, edit and delete the selected unique field.

Add Unique

To add an unique



Open the table in the Table Designer.

Open the Uniques tab.

Right-click and select the Add Unique from the popup menu or click the Add

Unique from the toolbar.

Edit unique properties.

Edit Unique

To edit an unique



Open the table in the Table Designer.

Open the Uniques tab.

Just simply click on the unique to edit.

Delete Unique

To delete an unique



Open the table in the Table Designer.

Open the Uniques tab.

Right-click on the unique to delete and select the Delete Unique from the popup menu or click the Delete Unique from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 385

Setting PostgreSQL Table Unique Properties

Use the Name edit box to set the unique name.

Fields

To set field(s) as unique, just simply double-click the Fields field or click to open the editor(s) for editing.

Select the field(s) from the list. To remove the fields from the unique, uncheck them in the same way.

Tablespace

Allows setting a tablespace different from the default tablespace.

The Comment edit box defines the comment for the unique.

Fill Factor

The fillfactor for a unqiue is a percentage between 10 and 100. 100 (complete packing) is the default.

Note: Support from PostgreSQL 8.2 or later.

Navicat Win 386

PostgreSQL Table Checks

A check constraint is the most generic constraint type. It allows you to specify that the value in a certain column must satisfy a Boolean (truth-value) expression.

Add Check

To add a check



Open the table in the Table Designer.

Open the Checks tab.

Right-click and select the Add Check from the popup menu or click the Add

Check from the toolbar.

Edit check properties.

Edit Check

To edit a check



Open the table in the Table Designer.

Open the Checks tab.

Just simply click on the check to edit.

Delete Check

To delete a check



Open the table in the Table Designer.

Open the Checks tab.

Right-click on the check to delete and select the Delete Check from the popup menu or click the Delete Check from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 387

Setting PostgreSQL Table Check Properties

Use the Name edit box to set the check name.

Check

Definition allows you to enter the definition for the check.

Comment allows you to enter the comment for the check.

Navicat Win 388

PostgreSQL Table Excludes

A exclude constraint guarantees that if any two rows are compared on the specified column(s) or expression(s) using the specified operator(s), not all of these comparisons will return

TRUE.

Excludes are managed on the Excludes tab of the Table Designer. Just simply click/double-click an exclude field for editing. Using the exclude toolbar, allowing you to create new, edit and delete the selected exclude field.

Note: Exclude is supported from PostgreSQL 9.0 or later.

Add Exclude

To add an exclude



Open the table in the Table Designer.

Open the Excludes tab.

Right-click and select the Add Exclude from the popup menu or click the Add

Exclude from the toolbar.

Edit exclude properties.

Edit Exclude

To edit an exclude



Open the table in the Table Designer.

Open the Excludes tab.

Just simply click on the exclude to edit.

Delete Exclude

To delete an exclude



Open the table in the Table Designer.

Open the Excludes tab.

Right-click on the exclude to delete and select the Delete Exclude from the popup menu or click the Delete Exclude from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 389

Setting PostgreSQL Table Exclude Properties

Use the Name edit box to set the exclude name.

Index method

The name of the index access method to be used.

Element

Choose the element(s) to be excluded and specify the operator(s).

Tablespace

The tablespace in which to create the index.

Fill Factor

The fillfactor for an index is a percentage that determines how full the index method will try to pack index pages.

Predicate

Specify an exclusion constraint on a subset of the table.

The Comment edit box defines the comment for the exclude.

Navicat Win 390

PostgreSQL Table Rules

The PostgreSQL rule system allows one to define an alternate action to be performed on insertions, updates, or deletions in database tables. Roughly speaking, a rule causes additional commands to be executed when a given command on a given table is executed.

Note: You must be the owner of a table to create or change rules for it.

Rules are managed on the Rules tab of the Table Designer. Just simply click/double-click a rule field for editing. Using the rule toolbar, allowing you to create new, edit and delete the selected rule field.

Add Rule

To add a rule



Open the table in the Table Designer.

Open the Rules tab.

Right-click and select the Add Rule from the popup menu or click the Add Rule from the toolbar.

Edit rule properties.

Edit Rule

To edit a rule



Open the table in the Table Designer.

Open the Rules tab.

Just simply click on the rule to edit.

Delete Rule

To delete a rule



Open the table in the Table Designer.

Open the Rules tab.

Right-click on the rule to delete and select the Delete Rule from the popup menu or click the Delete Rule from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 391

Setting PostgreSQL Table Rule Properties

Use the Name edit box to set the rule name. This must be distinct from the name of any other rule for the same table. Multiple rules on the same table and same event type are applied in alphabetical name order.

Event

The event is one of SELECT, INSERT, UPDATE, or DELETE.

Do instead

This indicates that the commands should be executed instead of the original command.

Otherwise, the commands should be executed in addition to the original command.

Condition

Any SQL conditional expression (returning boolean). The condition expression may not refer to any tables except NEW and OLD, and may not contain aggregate functions.

Definition

The command or commands that make up the rule action. Valid commands are SELECT,

INSERT, UPDATE, DELETE, or NOTIFY.

Within condition and command, the special table names NEW and OLD may be used to refer to values in the referenced table. NEW is valid in ON INSERT and ON UPDATE rules to refer to the new row being inserted or updated. OLD is valid in ON UPDATE and ON DELETE rules to refer to the existing row being updated or deleted

The Comment edit box defines the comment for the rule.

Navicat Win 392

PostgreSQL Table Triggers

Note: To create a trigger on a table, the user must have the TRIGGER privilege on the table.

Add Trigger

To add a trigger



Open the table in the Table Designer.

Open the Triggers tab.

Right-click and select the Add Trigger from the popup menu or click the Add

Trigger from the toolbar.

Edit trigger properties.

Edit Trigger

To edit a trigger



Open the table in the Table Designer.

Open the Triggers tab.

Just simply click on the trigger to edit.

Delete Trigger

To delete a trigger



Open the table in the Table Designer.

Open the Triggers tab.

Right-click on the trigger to delete and select the Delete Trigger from the popup menu or click the Delete Trigger from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 393

Setting PostgreSQL Table Trigger Properties

Use the Name edit box to set the trigger name. This must be distinct from the name of any other trigger for the same table.

Row trigger

This specifies whether the trigger procedure should be fired once for every row affected by the trigger event, or just once per SQL statement. If unchecks, FOR EACH STATEMENT is the default.

Use the Fires dropdown list to define the trigger action time. It can be Before or After to indicate that the trigger activates before or after the statement that activated it.

Insert

The trigger is activated whenever a new row is inserted into the table.

Update

The trigger is activated whenever a row is modified.

Delete

The trigger is activated whenever a row is deleted from the table.

Update Of Fields

Specify a list of columns. The trigger will only fire if at least one of the listed columns is mentioned as a target of the UPDATE command.

Note: Support from PostgreSQL 9.1 or later.

When Clause

Specify a Boolean WHEN condition, which will be tested to see whether the trigger should be fired.

Note: Support from PostgreSQL 9.0 or later.

Trigger Function Schema and Trigger Function

A user-supplied function that is declared as taking no arguments and returning type trigger, which is executed when the trigger fires.

Navicat Win 394

Arguments

An optional comma-separated list of arguments to be provided to the function when the trigger is executed. The arguments are literal string constants. Simple names and numeric constants may be written here, too, but they will all be converted to strings. Please check the description of the implementation language of the trigger function about how the trigger arguments are accessible within the function; it may be different from normal function arguments.

The Comment edit box defines the comment for the trigger.

Navicat Win 395

PostgreSQL Table Options

The Owner drop-down list defines the user to own this table.

The Tablespace drop-down list defines a tablespace different from the default tablespace to create a table.

Note: Support from PostgreSQL 8.0 or later.

Inherits from

This option specifies a list of tables from which the new table automatically inherits all columns. Use of inheritance creates a persistent relationship between the new child table and its parent table(s). Schema modifications to the parent(s) normally propagate to children as well, and by default the data of the child table is included in scans of the parent(s).

To set the new table to be inherited from one or several existing tables, just simply click to open the editor(s) for editing.

Has Oids

Check this option if you want to specify whether rows of the new table should have OIDs

(object identifiers) assigned to them.

Fill Factor

The fillfactor for a table is a percentage between 10 and 100. 100 (complete packing) is the default. When a smaller fillfactor is specified, INSERT operations pack table pages only to the indicated percentage; the remaining space on each page is reserved for updating rows on that page. This gives UPDATE a chance to place the updated copy of a row on the same page as the original, which is more efficient than placing it on a different page. For a table whose entries are never updated, complete packing is the best choice, but in heavily updated tables smaller fillfactors are appropriate.

Note: Support from PostgreSQL 8.2 or later.

Navicat Win 396

PostgreSQL Views

Views are useful for allowing users to access a set of relations (tables) as if it were a single table, and limiting their access to just that. Views can also be used to restrict access to rows

(a subset of a particular table).

Just simply click to open an object pane for View. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit, open and delete the selected view.

Create View

To create a new view



Select anywhere on the object pane.

Click the New View from the object pane toolbar. or

Right-click and select New View from the popup menu.

Edit view properties on the appropriate tabs of the View Designer.

Hint: To create new view you can also right-click the Views node of the navigation pane and select the New View from the popup menu.

To create a new view with the same properties as one of the existing views has (using drag and drop method)

Apply to: current database {same connection}



Select the view(s) for copying in the navigation pane/object pane.

Right-click and drag the chosen view(s) to the target location.

Select one of the following options: o

Copy here (Structure and Data) o o

Copy here (Structure only)

Move here o

Cancel

The newly created view(s) will be named as "viewname_copy".

Navicat Win 397

Apply to: different database {same connection} different database {different connection} (Data Transfer tool will be activated)



Select the view(s) for copying in the object pane.

Drag and drop the chosen view(s) to the target database.

Select one of the following options: o o o

Copy here (Structure and Data)

Copy here (Structure only)

Cancel

To create a new view with modification as one of the existing views



Select the view for modifying in the navigation pane/object pane.

Right-click and select the Design View from the popup menu. or

Click the Design View from the object pane toolbar.

Modify view properties on the appropriate tabs of the View Designer.

Click Save As.

To create a new view with loading from a SQL file



Select anywhere on the object pane.

Click the New View from the object pane toolbar. or

Right-click and select New View from the popup menu.

Click Load.

Create View Shortcut

To create a view shortcut



Select the view for editing in the navigation pane/object pane.

Right-click and select Create Open View Shortcut... from the popup menu.

Define the location you wish your shortcut to be saved.

Note: This option is used to provide a convenient way for you to open your view for entering data directly (Grid View/Form View) without activating the main Navicat.

Navicat Win 398

Edit View

To edit the existing view (manage its SQL definition etc)



Select the view for editing in the navigation pane/object pane.

Right-click and select the Design View from the popup menu. or

Click the Design View from the object pane toolbar.

Edit view properties on the appropriate tabs of the View Designer.

To change the name of the view



Select the view for editing in the navigation pane/object pane.

Right-click and select the Rename from the popup menu.

Open View

To open a view (manage view data)



Select the view for opening in the navigation pane/object pane.

Right-click and select the Open View from the popup menu or simply double-click the view. or

Click the Open View from the object pane toolbar.

Delete View

To delete a view



Select the view for deleting in the navigation pane/object pane.

Right-click and select the Delete View from the popup menu. or

Click the Delete View from the object pane toolbar.

Confirm deleting in the dialog window.

Navicat Win 399

Achieve View Information

To achieve a view information



Select the view in the object pane.

Right-click the selected view and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 400

PostgreSQL View Designer

View Designer is the basic Navicat tool for working with views. It allows you to create new view and edit the existing view definition (view name and the SELECT statement it implements).



Editing View Comment

View SQL Preview

Setting Parameters for Function

Navicat Win 401

Working with PostgreSQL View Builder (Available only in Full Version)

View Builder allows you to build views visually. It allows you to create and edit views without knowledge of SQL. See Query Builder for details.

Navicat Win 402

Editing PostgreSQL View SQL Definition

The Definition tab allows you to edit the view definition as SQL statement (SELECT statement it implements).

Example:

SELECT

report.clients.RecordID

FROM

report.clients

Hint: To customize the view of the editor and find out more features for sql editing, see Editor

View and More Features.

Navicat Win 403

Setting Advanced PostgreSQL View Properties

Owner

The owner of the view.

Navicat Win 404

PostgreSQL View Preview

To preview the result of the view, click Preview on the toolbar. If the query statement is correct, the Result and Message tabs will be opened.

The Result tab displays the data of the view as a grid ans the Message tab displays the message log.

Navicat Win 405

PostgreSQL View Explain

To show the Query Plan of the view, click Explain on the toolbar. If the query statement is correct, the Message tab will show the query plan.

Navicat Win 406

PostgreSQL View Viewer

View Viewer displays the view data as a grid. Data can be displayed in three modes:

Grid View, Form View and Text/Blob View. See Data View for details.

The toolbars of View Viewer provides the following functions for managing data:

 Export Data

Export data to MS Word, MS Excel, MS Access, TXT, DBF, HTML, SQL, RTF and more.

 Filter Data

Allow you to filter records by creating and applying filter criteria for the data grid.

 Edit TEXT/BLOB

Allow you to view and edit the content of TEXT and BLOB fields.

Navicat Win 407

PostgreSQL Functions

PostgreSQL provides four kinds of functions:



 query language functions (functions written in SQL) procedural language functions (functions written in, for example, PL/Tcl or PL/pgSQL) internal functions

C-language functions

Every kind of function can take base types, composite types, or combinations of these as arguments (parameters). In addition, every kind of function can return a base type or a composite type. Many kinds of functions can take or return certain pseudo-types (such as polymorphic types), but the available facilities vary.

Just simply click to open an object pane for Function. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected function.

Create Function

To create a new function



Select anywhere on the object pane.

Click the New Function from the object pane toolbar. or

Right-click and select New Function from the popup menu.

Edit function properties on the appropriate tabs of the Function Designer.

Hint: To create new function you can also right-click the Function node of the navigation pane and select the New Function from the popup menu.

Navicat Win 408

To create a new function with the same properties as one of the existing function has (using drag and drop method)

Apply to: current database {same connection}



Select the function(s) for copying in the navigation pane/object pane.

Right-click and drag the chosen function(s) to the target location.

Select one of the following options: o

Copy here (Structure and Data) o o

Copy here (Structure only)

Move here o

Cancel

The newly created function(s) will be named as "functionname_copy".

Apply to: different database {same connection} different database {different connection} (Data Transfer tool will be activated)



Select the function(s) for copying in the object pane.

Drag and drop the chosen function(s) to the target database.

Select one of the following options: o o o

Copy here (Structure and Data)

Copy here (Structure only)

Cancel

To create a new function with modification as one of the existing function



Select the function for modifying in the navigation pane/object pane.

Right-click and select the Design Function from the popup menu or simply double-click the function. or

Click the Design Function from the object pane toolbar.

Modify function properties on the appropriate tabs of the Function Designer.

Click Save As.

Navicat Win 409

Edit Function

To edit the existing function (manage its definition, advanced etc)



Select the function for editing in the navigation pane/object pane.

Right-click and select the Design Function from the popup menu or simply double-click the function. or

Click the Design Function from the object pane toolbar.

Edit function properties on the appropriate tabs of the Function Designer.

To change the name of the function



Select the function for editing in the navigation pane/object pane.

Right-click and select the Rename from the popup menu.

Run Function

To run a function in the navigation pane/object pane



Select the function for executing in the navigation pane/object pane.

Click the Execute Function from the object pane toolbar. or

Right-click and select Execute Function from the popup menu.

View/edit the returned data on the Result tab.

To run a function in the Function Designer



Create a new function/open the existing function.

Click Run.

View/edit the returned data on the Result tab.

Delete Function

To delete a function



Select the function for deleting in the navigation pane/object pane.

Right-click and select the Delete Function from the popup menu. or

Click the Delete Function from the object pane toolbar.

Confirm deleting in the dialog window.

Navicat Win 410

Achieve Function Information

To achieve a function information



Select the function in the object pane.

Right-click the selected function and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 411

PostgreSQL Function Wizard

Click the New Function from the object pane toolbar. The Function Wizard will pop up and it allows you to create a function easily.



Editing Function Definition

You are allowed not to show the Function Wizard when create new function.

Hint: Once uncheck the Show wizard next time, you can go to Options to enable it.

Navicat Win 412

Setting Parameters for PostgreSQL Function

Function

Define the parameter(s) of the function. Set the parameter Mode, Type Schema, Type,

Name and Default Value under corresponding columns.

Navicat Win 413

Setting Return Type for PostgreSQL Function

Select the Schema and Return Type from the list.

Navicat Win 414

PostgreSQL Function Designer

Function Designer is the basic Navicat tool for working with functions. It allows you to create new function and edit the existing function definition.



Setting Advanced Function Properties

Editing Function Comment

Function SQL Preview

Viewing Function Result

Navicat Win 415

Editing PostgreSQL Function Definition

Edit the function definition under the Definition tab. Definition consists of a valid SQL procedure statement. This can be a simple statement such as SELECT or INSERT, or it can be a compound statement written using BEGIN and END. Compound statements can contain declarations, loops, and other control structure statements. The general form of these statements follows.

Example:

BEGIN

RETURN i + j;

END

Hint: To customize the view of the editor and find out more features for sql editing, see Editor

View and More Features.

Parameter

Defines function parameter.

Return type schema and Return Type

It indicates the return type of the function.

Navicat Win 416

Setting Advanced PostgreSQL Function Properties

Owner

The owner of the function.

Note: Support from PostgreSQL 8.0 or later.

Language

The name of the language that the function is implemented in. May be SQL, C, internal, or the name of a user-defined procedural language. For backward compatibility, the name may be enclosed by single quotes.

Volatility

These attributes inform the query optimizer about the behavior of the function. At most one choice may be specified. If none of these appear, VOLATILE is the default assumption.

IMMUTABLE indicates that the function cannot modify the database and always returns the same result when given the same argument values; that is, it does not do database lookups or otherwise use information not directly present in its argument list. If this option is given, any call of the function with all-constant arguments can be immediately replaced with the function value.

STABLE indicates that the function cannot modify the database, and that within a single table scan it will consistently return the same result for the same argument values, but that its result could change across SQL statements. This is the appropriate selection for functions whose results depend on database lookups, parameter variables (such as the current time zone), etc. Also note that the current_timestamp family of functions qualify as stable, since their values do not change within a transaction.

VOLATILE indicates that the function value can change even within a single table scan, so no optimizations can be made. Relatively few database functions are volatile in this sense; some examples are random(), currval(), timeofday(). But note that any function that has side-effects must be classified volatile, even if its result is quite predictable, to prevent calls from being optimized away; an example is setval().

Security of definer

Specifies that the function is to be executed with the privileges of the user that created it.

Returns Set

Indicates that the function will return a set of items, rather than a single item.

Navicat Win 417

Strict

Indicates that the function always returns null whenever any of its arguments are null. If this parameter is specified, the function is not executed when there are null arguments; instead a null result is assumed automatically.

Estimated cost

A positive number giving the estimated execution cost for the function, in units of cpu_operator_cost. If the function returns a set, this is the cost per returned row. If the cost is not specified, 1 unit is assumed for C-language and internal functions, and 100 units for functions in all other languages. Larger values cause the planner to try to avoid evaluating the function more often than necessary.

Note: Support from PostgreSQL 8.3 or later.

Estimated rows

A positive number giving the estimated number of rows that the planner should expect the function to return. This is only allowed when the function is declared to return a set. The default assumption is 1000 rows.

Note: Support from PostgreSQL 8.3 or later.

Configuration parameter

The specified configuration parameter to be set to the specified value when the function is entered, and then restored to its prior value when the function exits.

Note: Support from PostgreSQL 8.3 or later.

Navicat Win 418

Viewing PostgreSQL Function Result

To run the function click Run on the toolbar. If the SQL statement is correct, the statement will be executed and, if the statement is supposed to return data, the Result tab opens with the data returned by the function. If an error occurs while executing the function, execution stops, the appropriate error message is displayed.

If the function requires input parameter, the Input Parameters box will popup. Use ',' to separate the parameters.

Note: The Result tab displays the result data as grid.

Hint: Navicat supports to return 10 resultsets.

Navicat Win 419

PostgreSQL Aggregates

Aggregate functions in PostgreSQL are expressed as state values and state transition functions. That is, an aggregate can be defined in terms of state that is modified whenever an input item is processed. To define a new aggregate function, one selects a data type for the state value, an initial value for the state, and a state transition function. The state transition function is just an ordinary function that could also be used outside the context of the aggregate. A final function can also be specified, in case the desired result of the aggregate is different from the data that needs to be kept in the running state value.

Just simply click -> Aggregate to open an object pane for Aggregate. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected aggregate.

Create Aggregate

To create a new aggregate



Select anywhere on the object pane.

Click the New Aggregate from the object pane toolbar. or

Right-click and select New Aggregate from the popup menu.

Edit aggregate properties on the appropriate tabs of the Aggregate Designer.

To create a new aggregate with modification as one of the existing aggregate



Select the aggregate for modifying in the object pane.

Right-click and select the Design Aggregate from the popup menu or simply double-click the aggregate. or

Click the Design Aggregate from the object pane toolbar.

Modify aggregate properties on the appropriate tabs of the Aggregate Designer.

Click Save As.

Navicat Win 420

Edit Aggregate

To edit the existing aggregate (manage its properties etc)



Select the aggregate for editing in the object pane.

Right-click and select the Design Aggregate from the popup menu or simply double-click the aggregate. or

Click the Design Aggregate from the object pane toolbar.

Edit aggregate properties on the appropriate tabs of the Aggregate Designer.

To change the name of the aggregate



Select the aggregate for editing in the object pane.

Right-click and select the Rename from the popup menu.

Note: Support from PostgreSQL 7.4 or later.

Delete Aggregate

To delete an aggregate



Select the aggregate for deleting in the object pane.

Right-click and select the Delete Aggregate from the popup menu. or

Click the Delete Aggregate from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Aggregate Information

To achieve an aggregate information



Select the aggregate in the object pane.

Right-click the selected aggregate and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 421

PostgreSQL Aggregate Designer

Aggregate Designer is the basic Navicat tool for working with aggregates. It allows you to create new aggregate and edit the existing aggregate properties.



Editing Aggregate Properties

Editing Aggregate Comment

Aggregate SQL Preview

Navicat Win 422

Editing PostgreSQL Aggregate Properties

Owner

The owner of the aggregate function.

Note: Support from PostgreSQL 8.0 or later.

Input type

An input data type on which this aggregate function operates.

Note: Support from PostgreSQL 8.2 or later. For versions below 8.2, just select the Input

type schema and Input type from the dropdown lists.

State type schema and State type

The data type for the aggregate's state value.

State function schema and State function

The state transition function to be called for each input row. For an N-argument aggregate function, the state function must take N+1 arguments, the first being of type

state_data_type and the rest matching the declared input data type(s) of the aggregate. The function must return a value of type state_data_type. This function takes the current state value and the current input data value(s), and returns the next state value.

Final function schema and Final function

The final function called to compute the aggregate's result after all input rows have been traversed. The function must take a single argument of type state_data_type. The return data type of the aggregate is defined as the return type of this function. If final function is not specified, then the ending state value is used as the aggregate's result, and the return type is state_data_type.

Initial condition

The initial setting for the state value. This must be a string constant in the form accepted for the data type state_data_type. If not specified, the state value starts out null.

Sort operator schema and Sort operator

The associated sort operator for a MIN- or MAX-like aggregate. The operator is assumed to have the same input data types as the aggregate (which must be a single-argument aggregate).

Note: Support from PostgreSQL 8.1 or later.

Navicat Win 423

PostgreSQL Conversions

Conversion defines a new conversion between character set encodings. Conversion names may be used in the convert function to specify a particular encoding conversion. Also, conversions that are marked DEFAULT can be used for automatic encoding conversion between client and server. For this purpose, two conversions, from encoding A to B and from encoding B to A, must be defined.

Just simply click -> Conversion to open an object pane for Conversion. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected conversion.

Create Conversion

To create a new conversion



Select anywhere on the object pane.

Click the New Conversion from the object pane toolbar. or

Right-click and select New Conversion from the popup menu.

Edit conversion properties on the appropriate tabs of the Conversion Designer.

To create a new conversion with modification as one of the existing conversion



Select the conversion for modifying in the object pane.

Right-click and select the Design Conversion from the popup menu or simply double-click the conversion. or

Click the Design Conversion from the object pane toolbar.

Modify conversion properties on the appropriate tabs of the Conversion Designer.

Click Save As.

Navicat Win 424

Edit Conversion

To edit the existing conversion (manage its properties etc)



Select the conversion for editing in the object pane.

Right-click and select the Design Conversion from the popup menu or simply double-click the conversion. or

Click the Design Conversion from the object pane toolbar.

Edit conversion properties on the appropriate tabs of the Conversion Designer.

To change the name of the conversion



Select the conversion for editing in the object pane.

Right-click and select the Rename from the popup menu.

Note: Support from PostgreSQL 7.4 or later.

Delete Conversion

To delete a conversion



Select the conversion for deleting in the object pane.

Right-click and select the Delete Conversion from the popup menu. or

Click the Delete Conversion from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Conversion Information

To achieve a conversion information



Select the conversion in the object pane.

Right-click the selected conversion and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 425

PostgreSQL Conversion Designer

Conversion Designer is the basic Navicat tool for working with conversions. It allows you to create new conversion and edit the existing conversion properties.



Editing Conversion Properties

Editing Conversion Comment

Conversion SQL Preview

Navicat Win 426

Editing PostgreSQL Conversion Properties

Owner

The owner of the conversion function.

Note: Support from PostgreSQL 8.0 or later.

Source encoding

The source encoding name.

Target encoding

The destination encoding name.

Schema of function and Function

The function used to perform the conversion. The function name may be schema-qualified. If it is not, the function will be looked up in the path.

The function must have the following signature: conv_proc( integer, -- source encoding ID integer, -- destination encoding ID cstring, -- source string (null terminated C string) internal, -- destination (fill with a null terminated C string) integer -- source string length

) RETURNS void;

Default

Check this box to indicate that this conversion is the default for this particular source to destination encoding. There should be only one default encoding in a schema for the encoding pair.

Navicat Win 427

PostgreSQL Domains

A domain is essentially a data type with optional constraints (restrictions on the allowed set of values). The user who defines a domain becomes its owner.

Domains are useful for abstracting common constraints on fields into a single location for maintenance. For example, several tables might contain email address columns, all requiring the same CHECK constraint to verify the address syntax. Define a domain rather than setting up each table's constraint individually.

Just simply click -> Domain to open an object pane for Domain. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected domain.

Create Domain

To create a new domain



Select anywhere on the object pane.

Click the New Domain from the object pane toolbar. or

Right-click and select New Domain from the popup menu.

Edit domain properties on the appropriate tabs of the Domain Designer.

To create a new domain with modification as one of the existing domain



Select the domain for modifying in the object pane.

Right-click and select the Design Domain from the popup menu or simply double-click the domain. or

Click the Design Domain from the object pane toolbar.

Modify domain properties on the appropriate tabs of the Domain Designer.

Click Save As.

Navicat Win 428

Edit Domain

To edit the existing domain (manage its general etc)



Select the domain for editing in the object pane.

Right-click and select the Design Domain from the popup menu or simply double-click the domain. or

Click the Design Domain from the object pane toolbar.

Edit domain properties on the appropriate tabs of the Domain Designer.

To change the name of the domain



Select the domain for editing in the object pane.

Right-click and select the Rename from the popup menu.

Delete Domain

To delete a domain



Select the domain for deleting in the object pane.

Right-click and select the Delete Domain from the popup menu. or

Click the Delete Domain from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Domain Information

To achieve a domain information



Select the domain in the object pane.

Right-click the selected domain and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 429

PostgreSQL Domain Designer

Domain Designer allows you to define domain properties and its checks. It allows you to create new domain and edit the existing domain properties.



Editing Domain General

Editing Domain Check

Editing Domain Comment

Domain SQL Preview

Navicat Win 430

Editing PostgreSQL Domain General

Underlying Type Category

Choose the underlying data type category: Base Type, Composite Type, Enum Type and

Domain.

Note: Support from PostgreSQL 8.2 or later.

Underlying Type Schema

Select schema of the underlying data type.

Underlying Type

Select the underlying data type of the domain from the drop-down list.

Dimensions

The dimensions of array specifiers.

Length and Scale

Use the Length edit box to define the length of the field and use Scale edit box to define the number of digits after the decimal point. (if required for the selected data type)

Default

The DEFAULT clause specifies a default value for columns of the domain data type. The value is any variable-free expression (but subqueries are not allowed). The data type of the default expression must match the data type of the domain. If no default value is specified, then the default value is the null value.

The default expression will be used in any insert operation that does not specify a value for the column. If a default value is defined for a particular column, it overrides any default associated with the domain. In turn, the domain default overrides any default value associated with the underlying data type.

Not null

Values of this domain are not allowed to be null.

Owner

The owner of the domain function. The user who defines a domain becomes its owner.

Note: Support from PostgreSQL 7.4 or later.

Navicat Win 431

Editing PostgreSQL Domain Check

The Checks tab is provided for managing domain checks. It allows you to create new, edit, or delete the selected check.

CHECK clauses specify integrity constraints or tests which values of the domain must satisfy.

Each constraint must be an expression producing a Boolean result. It should use the key word VALUE to refer to the value being tested.

See Checks for details.

Navicat Win 432

PostgreSQL Trigger Functions

Trigger Function can be created with PL/pgSQL and referenced within a PostgreSQL trigger definition. The term "trigger function" is a simply a way of referring to a function that is intended to be invoked by a trigger. Triggers define operations that are performed when a specific event occurs within the database. A PL/pgSQL trigger function can be referenced by a trigger as the operation to be performed when the trigger's event occurs.

The definition of a trigger and the definition of its associated trigger function are two different things. A trigger is defined with the SQL CREATE TRIGGER command, whereas trigger functions are defined using the SQL CREATE FUNCTION command.

Editing Trigger Function Definition

Just simply click -> Trigger Function to open an object pane for Trigger Function. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected trigger function.

Create Trigger Function

To create a new trigger function



Select anywhere on the object pane.

Click the New Trigger Function from the object pane toolbar. or

Right-click and select New Trigger Function from the popup menu.

Edit trigger function properties on the appropriate tabs of the Trigger Function

Designer.

To create a new trigger function with modification as one of the existing trigger function



Select the trigger function for modifying in the object pane.

Right-click and select the Design Trigger Function from the popup menu or simply double-click the trigger function. or

Click the Design Trigger Function from the object pane toolbar.

Modify trigger function properties on the appropriate tabs of the Trigger Function

Designer.

Click Save As.

Navicat Win 433

Edit Trigger Function

To edit the existing trigger function(manage its definition, advanced, etc)



Select the trigger function for editing in the object pane.

Right-click and select the Design Trigger Function from the popup menu or simply double-click the trigger function. or

Click the Design Trigger Function from the object pane toolbar.

Edit trigger function properties on the appropriate tabs of the Trigger Function

Designer.

To change the name of the trigger function



Select the trigger function for editing in the object pane.

Right-click and select the Rename from the popup menu.

Delete Trigger Function

To delete a trigger function



Select the trigger function for deleting in the object pane.

Right-click and select the Delete Trigger Function from the popup menu. or

Click the Delete Trigger Function from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Trigger Function Information

To achieve a trigger function information



Select the trigger function in the object pane.

Right-click the selected trigger function and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 434

PostgreSQL Trigger Function Designer

Trigger Function Designer is the basic Navicat tool for working with trigger functions. It allows you to create new trigger function and edit the existing trigger function definition.



Setting Advanced Trigger Function Properties

Editing Trigger Function Comment

Trigger Function SQL Preview

Navicat Win 435

Editing PostgreSQL Trigger Function Definition

Edit the trigger function definition under the Definition tab. Definition consists of a valid

Parameter

Defines trigger function parameter.

Return type schema and Return Type

It indicates the return type of the trigger function.

Hint: To customize the view of the editor and find out more features for sql editing, see Editor

View and More Features.

Navicat Win 436

Setting Advanced PostgreSQL Trigger Function Properties

Owner

The owner of the trigger function.

Note: Support from PostgreSQL 8.0 or later.

Language

The name of the language that the function is implemented in. May be C, internal, or the name of a user-defined procedural language. For backward compatibility, the name may be enclosed by single quotes.

Volatility

These attributes inform the query optimizer about the behavior of the function. At most one choice may be specified. If none of these appear, VOLATILE is the default assumption.

Security of definer

Specifies that the function is to be executed with the privileges of the user that created it.

Returns Set

Indicates that the function will return a set of items, rather than a single item.

Navicat Win 437

Strict

Estimated cost

Note: Support from PostgreSQL 8.2 or later.

Estimated rows

Note: Support from PostgreSQL 8.2 or later.

Configuration parameter

The specified configuration parameter to be set to the specified value when the function is entered, and then restored to its prior value when the function exits.

Note: Support from PostgreSQL 8.2 or later.

Navicat Win 438

PostgreSQL Operators

PostgreSQL supports left unary, right unary, and binary operators. Operators can be overloaded.

At least one of LEFTARG and RIGHTARG must be defined. For binary operators, both must be defined. For right unary operators, only LEFTARG should be defined, while for left unary operators only RIGHTARG should be defined.

Note: LEFTARG = Left type; RIGHTARG = Right type.

Just simply click -> Operator to open an object pane for Operator. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected operator.

Create Operator

To create a new operator



Select anywhere on the object pane.

Click the New Operator from the object pane toolbar. or

Right-click and select New Operator from the popup menu.

Edit operator properties on the appropriate tabs of the Operator Designer.

To create a new operator with modification as one of the existing operator



Select the operator for modifying in the object pane.

Right-click and select the Design Operator from the popup menu or simply double-click the operator. or

Click the Design Operator from the object pane toolbar.

Modify operator properties on the appropriate tabs of the Operator Designer.

Click Save As.

Navicat Win 439

Edit Operator

To edit the existing operator (manage its general etc)



Select the operator for editing in the object pane.

Right-click and select the Design Operator from the popup menu or simply double-click the operator. or

Click the Design Operator from the object pane toolbar.

Edit operator properties on the appropriate tabs of the Operator Designer.

To change the name of the operator



Select the operator for editing in the object pane.

Right-click and select the Rename from the popup menu.

Delete Operator

To delete an operator



Select the operator for deleting in the object pane.

Right-click and select the Delete Operator from the popup menu. or

Click the Delete Operator from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Operator Information

To achieve an operator information



Select the operator in the object pane.

Right-click the selected operator and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 440

PostgreSQL Operator Designer

Operator Designer is the basic Navicat tool for working with operator. It allows you to create new operator and edit the existing operator properties.



Editing Operator General

Editing Advanced Operator Properties

Editing Operator Comment

Operator SQL Preview

Navicat Win 441

Editing PostgreSQL Operator General

Owner

The owner of the operator function.

Note: Support from PostgreSQL 8.0 or later.

Schema of left type and Left type

The data type of the operator's left operand, if any. This option would be omitted for a left-unary operator.

Schema of right type and Right type

The data type of the operator's right operand, if any. This option would be omitted for a right-unary operator.

Schema of operator function and Operator function

The function used to implement this operator.

Navicat Win 442

Editing Advanced PostgreSQL Operator Properties

Schema of restrict function and Restrict function

The restriction selectivity estimator function for this operator.

Schema of join function and Join function

The join selectivity estimator function for this operator.

Schema of commutator and Commutator

The commutator of this operator.

Schema of negator and Negator

The negator of this operator.

Hash

The operator can support a hash join if this option on.

Merge

The operator can support a merge join if this option on.

Additional information for PostgreSQL version below 8.3

Schema of left sort operator and Left sort operator

If this operator can support a merge join, the left sort operator that sorts the left-hand data type of this operator.

Schema of right sort operator and Right sort operator

If this operator can support a merge join, the right sort operator that sorts the right-hand data type of this operator.

Schema of less than operator and Less than operator

If this operator can support a merge join, the less-than operator that compares the input data types of this operator.

Schema of greater than operator and Greater than operator

If this operator can support a merge join, the greater-than operator that compares the input data types of this operator.

Navicat Win 443

PostgreSQL Operator Classes

An operator class defines how a particular data type can be used with an index. The operator class specifies that certain operators will fill particular roles or "strategies" for this data type and this index method. The operator class also specifies the support procedures to be used by the index method when the operator class is selected for an index column. All the operators and functions used by an operator class must be defined before the operator class is created.

Note: Two operator classes in the same schema can have the same name only if they are for different index methods.

Just simply click -> Operator Class to open an object pane for Operator Class. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected operator class.

Create Operator Class

To create a new operator class



Select anywhere on the object pane.

Click the New Operator Class from the object pane toolbar. or

Right-click and select New Operator Class from the popup menu.

Edit operator class properties on the appropriate tabs of the Operator Class Designer.

To create a new operator class with modification as one of the existing operator class



Select the operator class for modifying in the object pane.

Right-click and select the Design Operator Class from the popup menu or simply double-click the operator class. or

Click the Design Operator Class from the object pane toolbar.

Modify operator class properties on the appropriate tabs of the Operator Class

Designer.

Click Save As.

Navicat Win 444

Edit Operator Class

To edit the existing operator class(manage its general, operators etc)



Select the operator class for editing in the object pane.

Right-click and select the Design Operator Class from the popup menu or simply double-click the operator class. or

Click the Design Operator Class from the object pane toolbar.

Edit operator class properties on the appropriate tabs of the Operator Class Designer.

To change the name of the operator class



Select the operator class for editing in the object pane.

Right-click and select the Rename from the popup menu.

Delete Operator Class

To delete an operator class



Select the operator class for deleting in the object pane.

Right-click and select the Delete Operator Class from the popup menu. or

Click the Delete Operator Class from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Operator Class Information

To achieve an operator class information



Select the operator class in the object pane.

Right-click the selected operator class and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 445

PostgreSQL Operator Class Designer

Operator Class Designer is the basic Navicat tool for working with operator class. It allows you to create new operator class and edit the existing operator class properties.



Editing Operator Class General

Editing Operator Class Operators

Editing Operator Class Functions

Editing Operator Class Comment (Support from PostgreSQL 8.0 or later)

Operator Class SQL Preview

Navicat Win 446

Editing PostgreSQL Operator Class General

Owner

The owner of the operator class function.

Note: Support from PostgreSQL 8.0 or later.

Schema of data type and Data Type

The column data type that this operator class is for.

Index method

The name of the index method this operator class is for.

Schema of storage type and Storage type

The data type actually stored in the index. Normally this is the same as the column data type, but some index methods (GIN and GiST for now) allow it to be different. The STORAGE clause must be omitted unless the index method allows a different type to be used.

Operator family

The name of the existing operator family to add this operator class to. If not specified, a family named the same as the operator class is used (creating it, if it doesn't already exist).

Note: Support from PostgreSQL 8.3 or later.

Default operator class

With this option selected, the operator class will become the default operator class for its data type. At most one operator class can be the default for a specific data type and index method.

Navicat Win 447

Editing PostgreSQL Operator Class Operators

Strategy number

The index method's strategy number for an operator associated with the operator class.

Schema of operator and Operator name

The operator associated with the operator class.

Recheck

With this option selected, the index is "lossy" for this operator, and so the rows retrieved using the index must be rechecked to verify that they actually satisfy the qualification clause involving this operator.

Note: Before PostgreSQL 8.4, the OPERATOR clause could include a RECHECK option. This is no longer supported because whether an index operator is "lossy" is now determined on-the-fly at runtime. This allows efficient handling of cases where an operator might or might not be lossy.

Navicat Win 448

Editing PostgreSQL Operator Class Functions

Support number

The index method's support procedure number for a function associated with the operator class.

Schema of function and Function name

The function that is an index method support procedure for the operator class.

Navicat Win 449

PostgreSQL Sequences

Sequence involves creating and initializing a new special single-row table. It is usually used to generate unique identifiers for rows of a table.

Just simply click -> Sequence to open an object pane for Sequence. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected sequence.

Create Sequence

To create a new sequence



Select anywhere on the object pane.

Click the New Sequence from the object pane toolbar. or

Right-click and select New Sequence from the popup menu.

Edit sequence properties on the appropriate tabs of the Sequence Designer.

To create a new sequence with modification as one of the existing sequence



Select the sequence for modifying in the object pane.

Right-click and select the Design Sequence from the popup menu or simply double-click the sequence. or

Click the Design Sequence from the object pane toolbar.

Modify sequence properties on the appropriate tabs of the Sequence Designer.

Click Save As.

Edit Sequence

To edit the existing sequence(manage its general etc)



Select the sequence for editing in the object pane.

Right-click and select the Design Sequence from the popup menu or simply double-click the sequence. or

Click the Design Sequence from the object pane toolbar.

Edit sequence properties on the appropriate tabs of the Sequence Designer.

Navicat Win 450

To change the name of the sequence



Select the sequence for editing in the object pane.

Right-click and select the Rename from the popup menu.

Delete Sequence

To delete a sequence



Select the sequence for deleting in the object pane.

Right-click and select the Delete Sequence from the popup menu. or

Click the Delete Sequence from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Sequence Information

To achieve a sequence information



Select the sequence in the object pane.

Right-click the selected sequence and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 451

PostgreSQL Sequence Designer

Sequence Designer is the basic Navicat tool for working with sequence. It allows you to create new sequence and edit the existing sequence properties.



Editing Sequence General

Editing Sequence Comment

Sequence SQL Preview

Navicat Win 452

Editing PostgreSQL Sequence General

Owner

The owner of the sequence function.

Note: Support from PostgreSQL 8.0 or later.

Increment

Specifies which value is added to the current sequence value to create a new value. A positive value will make an ascending sequence, a negative one a descending sequence. The default value is 1.

Current value

The starting value of the sequence.

Minimum

Determines the minimum value a sequence can generate. If no minimum value is specified, then defaults will be used.

Maximum

Determines the maximum value for the sequence. If no maximum value is specified, then default values will be used.

Cache

Specifies how many sequence numbers are to be preallocated and stored in memory for faster access. The minimum value is 1 (only one value can be generated at a time, i.e., no cache), and this is also the default.

Cycled

This option allows the sequence to wrap around when the maxvalue or minvalue has been reached by an ascending or descending sequence respectively. If the limit is reached, the next number generated will be the minvalue maxvalue, respectively. Otherwise, any calls to nextval after the sequence has reached its maximum value will return an error.

Navicat Win 453

Add owned by

Choose the Owned by table and Owned by column so that the sequence is associated with a specific table column, such that if that column (or its whole table) is dropped, the sequence will be automatically dropped as well. The specified table must have the same owner and be in the same schema as the sequence.

Note: Support from PostgreSQL 8.2 or later.

Navicat Win 454

PostgreSQL Types

Type registers a new data type for use in the current database. If a schema name is given then the type is created in the specified schema. Otherwise it is created in the current schema. The type name must be distinct from the name of any existing type or domain in the same schema. (Because tables have associated data types, the type name must also be distinct from the name of any existing table in the same schema.)

Just simply click -> Type to open an object pane for Type. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected type.

Note: Enum Type was added in PostgreSQL 8.3.

Create Type

To create a new type



Select anywhere on the object pane.

Click the New Type from the object pane toolbar together with the down arrow to choose New Base Type / New Composite Type / New Enum Type. or

Right-click and select New Type -> New Base Type / New Composite Type /

New Enum Type from the popup menu.

Edit type properties on the appropriate tabs of the Type Designer.

To create a new type with modification as one of the existing type



Select the type for modifying in the object pane.

Right-click and select the Design Type from the popup menu or simply double-click the type. or

Click the Design Type from the object pane toolbar.

Modify type properties on the appropriate tabs of the Type Designer.

Click Save As.

Navicat Win 455

Edit Type

To edit the existing type(manage its general etc)



Select the type for editing in the object pane.

Right-click and select the Design Type from the popup menu or simply double-click the type. or

Click the Design Type from the object pane toolbar.

Edit type properties on the appropriate tabs of the Type Designer.

Delete Type

To delete a type



Select the type for deleting in the object pane.

Right-click and select the Delete Type from the popup menu. or

Click the Delete Type from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Type Information

To achieve a type information



Select the type in the object pane.

Right-click the selected type and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 456

PostgreSQL Type Designer

Type Designer is the basic Navicat tool for working with type. It allows you to create new type and edit the existing type properties.



Editing Base Type Properties

Editing Composite Type Properties

Editing Enum Type Properties

Editing Type Comment

Type SQL Preview

Navicat Win 457

Editing PostgreSQL Base Type Properties

Base types are those, like int4, that are implemented below the level of the SQL language

(typically in a low-level language such as C). They generally correspond to what are often known as abstract data types. PostgreSQL can only operate on such types through functions provided by the user and only understands the behavior of such types to the extent that the user describes them. Base types are further subdivided into scalar and array types. For each scalar type, a corresponding array type is automatically created that can hold variable-size arrays of that scalar type.



Editing Base Type General

Editing Advanced Base Type Properties

Navicat Win 458

Editing PostgreSQL Base Type General

Input Schema and Input

The function that converts data from the type's external textual form to its internal form.

Output Schema and Output

The function that converts data from the type's internal form to its external textual form.

Length

A numeric constant that specifies the length in bytes of the new type's internal representation. The default assumption is that it is variable-length.

Variable

Checks this option if the type length is unknown.

Default

The default value for the data type. If this is omitted, the default is null.

Element

The type being created is an array; this specifies the type of the array elements.

Delimiter

The delimiter character to be used between values in arrays made of this type.

Alignment

The storage alignment requirement of the data type. If specified, it must be char, int2, int4, or double; the default is int4.

Storage

The storage strategy for the data type. If specified, must be plain, external, extended, or main; the default is plain.

Pass by value

Indicates that values of this data type are passed by value rather than by reference.

Owner

The owner of the type.

Note: Support from PostgreSQL 8.0 or later.

Navicat Win 459

Editing Advanced PostgreSQL Base Type Properties

The Advanced tab is supported from PostgreSQL 7.4 or later.

Receive Schema and Receive

The function that converts data from the type's external binary form to its internal form.

Send Schema and Send

The function that converts data from the type's internal form to its external binary form.

Analyze Schema and Analyze

The function that performs statistical analysis for the data type.

Note: Support from PostgreSQL 8.0 or later.

Type Modifier Input Schema and Type Modifier Input

The function that converts an array of modifier(s) for the type into internal form.

Note: Support from PostgreSQL 8.3 or later.

Type Modifier Output Schema and Type Modifier Output

The function that converts the internal form of the type's modifier(s) to external textual form.

Note: Support from PostgreSQL 8.3 or later.

Navicat Win 460

Editing PostgreSQL Composite Type Properties

Composite types, or row types, are created whenever the user creates a table; it's also possible to define a "stand-alone" composite type with no associated table. A composite type is simply a list of base types with associated field names. A value of a composite type is a row or record of field values. The user can access the component fields from SQL queries.



Editing Composite Type General

Navicat Win 461

Editing PostgreSQL Composite Type General

Name

The name of an attribute (column) for the composite type.

Type

The name of an existing data type to become a column of the composite type.

Length and Scale

Use the Length edit box to define the length of the field and use Scale edit box to define the number of digits after the decimal point. (if required for the selected data type)

Dimensions

The dimensions of array specifiers.

Owner

The owner of the type.

Note: Support from PostgreSQL 8.0 or later.

Navicat Win 462

Editing PostgreSQL Enum Type Properties

Enumerated (Enum) types are data types that are comprised of a static, predefined set of values with a specific order. They are equivalent to the enum types in a number of programming languages. An example of an enum type might be the days of the week, or a set of status values for a piece of data.

Note: Enum Type was added in PostgreSQL 8.3.



Editing Enum Type General

Navicat Win 463

Editing PostgreSQL Enum Type General

Label

A string literal representing the textual label associated with one value of an enum type.

Owner

The owner of the type.

Navicat Win 464

PostgreSQL Tablespaces

A tablespace allows superusers to define an alternative location on the file system where the data files containing database objects (such as tables and indexes) may reside.

Just simply click -> Tablespace to open an object pane for Tablespace. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected tablespace.

Note: Tablespace was added in PostgreSQL 8.0.

Create Tablespace

To create a new tablespace



Select anywhere on the object pane.

Click the New Tablespace from the object pane toolbar. or

Right-click and select New Tablespace from the popup menu.

Edit tablespace properties on the appropriate tabs of the Tablespace Designer.

Edit Tablespace

To edit the existing tablespace(manage its general, privileges etc)



Select the tablespace for editing in the object pane.

Right-click and select the Design Tablespace from the popup menu or simply double-click the tablespace. or

Click the Design Tablespace from the object pane toolbar.

Edit tablespace properties on the appropriate tabs of the Tablespace Designer.

To change the name of the tablespace



Select the tablespace for editing in the object pane.

Right-click and select the Rename from the popup menu.

Navicat Win 465

Delete Tablespace

To delete a tablespace



Select the tablespace for deleting in the object pane.

Right-click and select the Delete Tablespace from the popup menu. or

Click the Delete Tablespace from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Tablespace Information

To achieve a tablespace information



Select the tablespace in the object pane.

Right-click the selected tablespace and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 466

PostgreSQL Tablespace Designer

Tablespace Designer is the basic Navicat tool for working with tablespace. It allows you to create new tablespace and edit the existing tablespace properties.



Editing Tablespace General

Editing Tablespace Comment (Support from PostgreSQL 8.2 or later)

Tablespace SQL Preview

Navicat Win 467

Editing PostgreSQL Tablespace General

Location

The directory that will be used for the tablespace. The directory must be empty and must be owned by the PostgreSQL system user. The directory must be specified by an absolute path name.

Owner

The name of the user who will own the tablespace. If omitted, defaults to the user executing the command. Only superusers may create tablespaces, but they can assign ownership of tablespaces to non-superusers.

Navicat Win 468

PostgreSQL Casts

A cast specifies how to perform a conversion between two data types.

Just simply click -> Cast to open an object pane for Cast. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected cast.

Create Cast

To create a new cast



Select anywhere on the object pane.

Click the New Cast from the object pane toolbar. or

Right-click and select New Cast from the popup menu.

Edit cast properties on the appropriate tabs of the Cast Designer.

To create a new cast with modification as one of the existing cast



Select the cast for modifying in the object pane.

Right-click and select the Design Cast from the popup menu or simply double-click the cast. or

Click the Design Cast from the object pane toolbar.

Modify cast properties on the appropriate tabs of the Cast Designer.

Click Save As.

Edit Cast

To edit the existing cast(manage its general etc)



Select the cast for editing in the object pane.

Right-click and select the Design Cast from the popup menu or simply double-click the cast. or

Click the Design Cast from the object pane toolbar.

Edit cast properties on the appropriate tabs of the Cast Designer.

Navicat Win 469

Delete Cast

To delete a cast



Select the cast for deleting in the object pane.

Right-click and select the Delete Cast from the popup menu. or

Click the Delete Cast from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Cast Information

To achieve a cast information



Select the cast in the object pane.

Right-click the selected cast and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 470

PostgreSQL Cast Designer

Cast Designer is the basic Navicat tool for working with cast. It allows you to create new cast and edit the existing cast properties.



Editing Cast General

Editing Cast Comment (Support from PostgreSQL 8.0 or later)

Cast SQL Preview

Navicat Win 471

Editing PostgreSQL Cast General

Schema of source type and Source type

The schema and name of the source data type of the cast.

Schema of target type and Target type

The schema and name of the target data type of the cast.

Schema of function and Function

The function used to perform the cast. The function name may be schema-qualified. If it is not, the function will be looked up in the schema search path. The function's result data type must match the target type of the cast.

If no function is specify, indicates that the source type and the target type are binary compatible, so no function is required to perform the cast.

Implicit

Indicates that the cast may be invoked implicitly in any context.

Assignment

Indicates that the cast can be invoked implicitly in assignment contexts.

Navicat Win 472

PostgreSQL Languages

Language can register a new procedural language with a PostgreSQL database.

Subsequently, functions and trigger procedures can be defined in this new language. The user must have the PostgreSQL superuser privilege to register a new language.

Just simply click -> Language to open an object pane for Language. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected Language.

Create Language

To create a new language



Select anywhere on the object pane.

Click the New Language from the object pane toolbar. or

Right-click and select New Language from the popup menu.

Edit language properties on the appropriate tabs of the Language Designer.

To create a new language with modification as one of the existing language



Select the language for modifying in the object pane.

Right-click and select the Design Language from the popup menu or simply double-click the language. or

Click the Design Language from the object pane toolbar.

Modify language properties on the appropriate tabs of the Language Designer.

Click Save As.

Edit Language

To edit the existing language(manage its properties, privileges etc)



Select the language for editing in the object pane.

Right-click and select the Design Language from the popup menu or simply double-click the language. or

Click the Design Language from the object pane toolbar.

Edit language properties on the appropriate tabs of the Language Designer.

Navicat Win 473

To change the name of the language



Select the language for editing in the object pane.

Right-click and select the Rename from the popup menu.

Note: Support from PostgreSQL 7.4 or later.

Delete Language

To delete a language



Select the language for deleting in the object pane.

Right-click and select the Delete Language from the popup menu. or

Click the Delete Language from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Language Information

To achieve a language information



Select the language in the object pane.

Right-click the selected language and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 474

PostgreSQL Language Designer

Language Designer is the basic Navicat tool for working with language. It allows you to create new language and edit the existing language properties.



Editing Language General

Editing Language Comment (Support from PostgreSQL 8.0 or later)

Language SQL Preview

Navicat Win 475

Editing PostgreSQL Language General

Owner

The owner of the language.

Note: Support from PostgreSQL 8.3 or later.

Schema of handler and Handler

Call Handler is the name of a previously registered function that will be called to execute the procedural language functions. The call handler for a procedural language must be written in a compiled language such as C with version 1 call convention and registered with PostgreSQL as a function taking no arguments and returning the language_handler type, a placeholder type that is simply used to identify the function as a call handler.

Schema of validator and Validator

Validator function is the name of a previously registered function that will be called when a new function in the language is created, to validate the new function. If no validator function is specified, then a new function will not be checked when it is created. The validator function must take one argument of type oid, which will be the OID of the to-be-created function, and will typically return void.

A validator function would typically inspect the function body for syntactical correctness, but it can also look at other properties of the function, for example if the language cannot handle certain argument types. To signal an error, the validator function should use the ereport() function. The return value of the function is ignored.

Trusted

Specifies that the call handler for the language is safe, that is, it does not offer an unprivileged user any functionality to bypass access restrictions. If this key word is omitted when registering the language, only users with the PostgreSQL superuser privilege can use this language to create new functions.

Navicat Win 476

SQLite Database Object Management

The following list contains the most common SQLite database objects supported by Navicat.



Navicat Win 477

SQLite Tables

Just simply click to open an object pane for Table. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit, open and delete the selected table.

Create Table

To create a new table



Select anywhere on the object pane.

Click the New Table from the object pane toolbar. or

Right-click and select New Table from the popup menu.

Edit table properties and fields on the appropriate tabs of the Table Designer.

Hint: To create new table you can also right-click the Tables node of the navigation pane and select the New Table from the popup menu.

To create a new table with the same properties as one of the existing tables has (using popup menu)

Apply to: current database {same connection}



Select the table(s) for copying in the navigation pane/object pane.

Right-click and select the Duplicate Table from the popup menu.

The newly created table(s) will be named as "tablename_copy".

Navicat Win 478

To create a new table with the same properties as one of the existing tables has (using drag and drop method)

Apply to: current database {same connection}



Select the table(s) for copying in the navigation pane/object pane.

Right-click and drag the chosen table(s) to the target location.

Select one of the following options: o

Copy here (Structure and Data) o o

Copy here (Structure only)

Move here o

Cancel

The newly created table(s) will be named as "tablename_copy"

Apply to: different database {same connection} different database {different connection (same or cross server type)} (Data Transfer tool will be activated)



Select the table(s) for copying in the object pane.

Drag and drop the chosen table(s) to the target database.

Select one of the following options: o o o

Copy here (Structure and Data)

Copy here (Structure only)

Cancel

To create a new table with modification as one of the existing tables



Select the table for modifying in the navigation pane/object pane.

Right-click and select the Design Table from the popup menu. or

Click the Design Table from the object pane toolbar.

Modify table properties and fields on the appropriate tabs of the Table Designer.

Click Save As.

Navicat Win 479

Create Table Shortcut

To create a table shortcut



Select the table for editing in the navigation pane/object pane.

Right-click and select Create Open Table Shortcut... from the popup menu.

Define the location you wish your shortcut to be saved.

Note: This option is used to provide a convenient way for you to open your table for entering data directly (Grid View/Form View) without activating the main Navicat.

Edit Table

To edit the existing table (manage its fields, indexes, foreign keys and triggers etc)



Select the table for editing in the navigation pane/object pane.

Right-click and select the Design Table from the popup menu. or

Click the Design Table from the object pane toolbar.

Edit table properties and fields on the appropriate tabs of the Table Designer.

To change the name of the table



Select the table for editing in the navigation pane/object pane.

Right-click and select the Rename from the popup menu.

Open Table (manage table data)

To open a table



Select the table for opening in the navigation pane/object pane.

Right-click and select the Open Table from the popup menu or simply double-click the table. or

Click the Open Table from the object pane toolbar.

Note: This option is only applied if you do wish Navicat loads all your images while opening the table. To open the graphical table with faster performance, use Open

Table (Quick) below.

Navicat Win 480

To open a table with graphical fields



Select the table for opening in the navigation pane/object pane.

Right-click and select the Open Table (Quick) from the popup menu.

Note: Faster performance for opening the graphical table, as BLOB fields (images) will not be loaded until you click on the cell.

Empty Table

To empty a table



Select the table in the navigation pane/object pane.

Right-click the selected table and choose Empty Table from the popup menu.

Delete Table

To delete a table



Select the table for deleting in the navigation pane/object pane.

Right-click and select the Delete Table from the popup menu. or

Click the Delete Table from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Table Information

To achieve a table information



Select the table in the navigation pane/object pane.

Right-click the selected table and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 481

SQLite Table Designer

Table Designer is the basic Navicat tool for working with tables. It allows you to create, edit and drop table's fields, indexes, foreign keys, and much more.



Table SQL Preview

Navicat Win 482

SQLite Table Fields

Add Field

To add a field to the table



Open the table in the Table Designer.

Open the Fields tab.

Right-click and select the Add Field from the popup menu or click the Add Field from the toolbar.

Edit field properties.

To add a new field with modification as one of the existing fields



Open the table in the Table Designer.

Open the Fields tab.

Select field.

Right-click and select the Duplicate Field from the popup menu.

Edit field properties.

Insert Field

To insert a field above an existing field



Open the table in the Table Designer.

Open the Fields tab.

Select field.

Right-click and select the Insert Field from the popup menu or click the Insert

Field from the toolbar.

Define field properties in the empty row.

Navicat Win 483

Edit Field

To edit the table field



Open the table in the Table Designer.

Open the Fields tab.

Simply click on the field to edit.

To change the order of the table fields



Open the table in the Table Designer.

Open the Fields tab.

Right-click on the field to move and select the Move Up/ Move Down from the popup menu or click the Move Up/ Move Down from the toolbar.

Delete Field

To delete the table field



Open the table in the Table Designer.

Open the Fields tab.

Right-click on the field to delete and select the Delete Field from the popup menu or click the Delete Field from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 484

Setting SQLite Table Field Properties

Name

StreetAddress, or HomePhone.

Use the Name edit box to set the field name. Note that the name of the field must be unique among all the field names in the table.

Type

The Type dropdown list defines the type (storage class) of the field data.

The following tables summarize each type:

Type

INTEGER

REAL

TEXT

Description

The value is a signed integer, stored in 1, 2, 3, 4, 6, or 8 bytes depending on the magnitude of the value.

The value is a floating point value, stored as an 8-byte IEEE floating point number.

The value is a text string, stored using the database encoding

(UTF-8, UTF-16BE or UTF-16LE).

BLOB The value is a blob of data, stored exactly as it was input.

Note for SQLite Version 2:

1. You can store any kind of data you want in any column of any table, regardless of

the declared datatype of that column.

Click here for detailed description on datatype in SQLite version 2.

Navicat Win 485

Note for SQLite Version 3:

1. Storage class is slightly more general than a datatype. The INTEGER storage class,

for example, includes 6 different integer datatypes of different lengths.

2. In order to maximize compatibility between SQLite and other database engines,

SQLite supports the concept of "type affinity" on columns.

Click here for detailed description on datatype, storage class and type affinity.

Length and Decimals

Use the Length edit box to define the length of the field and use Decimals edit box to define the number of digits after the decimal point (the scale).

Allow Null

Allow the NULL values for the field.

Primary Key

A Primary Key is a single field or combination of fields that uniquely defines a record. None of the fields that are part of the primary key can contain a null value.

Navicat Win 486

Setting Other SQLite Table Field Properties

Default

To set the default value for the field.

Collation

To specify the text collating function to use when comparing text entries for the column. The built-in BINARY collating function is used by default.

BINARY

Compares string data using memcmp(), regardless of text encoding.

NOCASE

The same as binary, except the 26 upper case characters of ASCII are folded to their lower case equivalents before the comparison is performed. Note that only ASCII characters are case folded. SQLite does not attempt to do full UTF case folding due to the size of the tables required.

RTRIM

The same as binary, except that trailing space characters are ignored.

Note: Support in SQLite 3.

Not null ON CONFLICT

To specify an algorithm used to resolve constraint conflicts if Allow Null option is unchecked.

The default conflict resolution algorithm is ABORT.

ROLLBACK

When a constraint violation occurs, an immediate ROLLBACK occurs, thus ending the current transaction, and the command aborts with a return code of

SQLITE_CONSTRAINT. If no transaction is active (other than the implied transaction that is created on every command) then this algorithm works the same as ABORT.

ABORT

When a constraint violation occurs, the command backs out any prior changes it might have made and aborts with a return code of SQLITE_CONSTRAINT. But no ROLLBACK is executed so changes from prior commands within the same transaction are preserved.

This is the default behavior.

Navicat Win 487

FAIL

When a constraint violation occurs, the command aborts with a return code

SQLITE_CONSTRAINT. But any changes to the database that the command made prior to encountering the constraint violation are preserved and are not backed out. For example, if an UPDATE statement encountered a constraint violation on the 100th row that it attempts to update, then the first 99 row changes are preserved but changes to rows 100 and beyond never occur.

IGNORE

When a constraint violation occurs, the one row that contains the constraint violation is not inserted or changed. But the command continues executing normally. Other rows before and after the row that contained the constraint violation continue to be inserted or updated normally. No error is returned when the IGNORE conflict resolution algorithm is used.

REPLACE

When a UNIQUE constraint violation occurs, the pre-existing rows that are causing the constraint violation are removed prior to inserting or updating the current row. Thus the insert or update always occurs. The command continues executing normally following

REPLACE. No error is returned by the REPLACE conflict resolution. If a NOT NULL constraint violation occurs, the NULL value is replaced by the default value for that column. If the column has no default value, then the ABORT algorithm is used. If a

CHECK constraint violation occurs then the IGNORE algorithm is used.

Auto Increment (INTEGER only)

The AUTO INCREMENT attribute can be used to generate a unique identity for new rows. To start with the AUTO INCREMENT value other than 1, you can set that value in Options tab.

Navicat Win 488

SQLite Table Indexes

Index provides a faster access path to table data. It is created using one or more columns of a table to speed SQL statement execution on that table.

Add Index

To add a table index



Open the table in the Table Designer.

Open the Indexes tab.

Right-click and select the Add Index from the popup menu or click the Add

Index from the toolbar.

Edit index properties.

Edit Index

To edit a table index



Open the table in the Table Designer.

Open the Indexes tab.

Just simply click/double-click on the index to edit.

Delete Index

To delete a table index



Open the table in the Table Designer.

Open the Indexes tab.

Right-click on the index to delete and select the Delete Index from the popup menu or click the Delete Index from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 489

Setting SQLite Table Index Properties

Use the Name edit box to set the index name.

To include field(s) in the index, just simply double-click the Fields

Select the field(s) from the list. To remove the fields from the index, uncheck them in the same way. You can also use the arrow buttons to change the index field(s) order.

Collation

To define a collating sequence used for text entries in that column. The default collating sequence is the collating sequence defined for that column.

BINARY

Compares string data using memcmp(), regardless of text encoding.

NOCASE

RTRIM

The same as binary, except that trailing space characters are ignored.

Note: Support in SQLite 3.

Navicat Win 490

Sort Order

To indicate sort order - ascending "ASC" or descending "DESC".

Unique

All values of the indexed column(s) must only occur once.

Navicat Win 491

SQLite Table Foreign Keys

A foreign key is a field in a relational table that matches the primary key column of another table.

Add Foreign Key

To add a foreign key



Open the table in the Table Designer.

Open the Foreign Keys tab.

Right-click and select the Add Foreign Key from the popup menu or click the

Add Foreign Key from the toolbar.

Edit foreign key properties.

Edit Foreign Key

To edit a foreign key



Open the table in the Table Designer.

Open the Foreign Keys tab.

Just simply click/double-click on the foreign key to edit.

Delete Foreign Key

To delete a foreign key



Open the table in the Table Designer.

Open the Foreign Keys tab.

Right-click on the foreign key to delete and select the Delete Foreign Key from the popup menu or click the Delete Foreign Key from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 492

Setting SQLite Table Foreign Key Properties

Use the Name edit box to enter a name for the new key and then select a table field to include in the key from the Fields group.

Use the Reference Table dropdown list to select a foreign table respectively.

To include field(s) to the key, just simply double-click the Fields/Reference Fields field or click to open the editor(s) for editing.

The On Delete and On Update dropdown list define the type of the actions to be taken.

RESTRICT

The "RESTRICT" action means that the application is prohibited from deleting (for ON

DELETE RESTRICT) or modifying (for ON UPDATE RESTRICT) a parent key when there exists one or more child keys mapped to it.

NO ACTION

Configuring "NO ACTION" means just that: when a parent key is modified or deleted from the database, no special action is taken.

CASCADE

A "CASCADE" action propagates the delete or update operation on the parent key to each dependent child key. For an "ON DELETE CASCADE" action, this means that each row in the child table that was associated with the deleted parent row is also deleted. For an "ON UPDATE CASCADE" action, it means that the values stored in each dependent child key are modified to match the new parent key values.

SET NULL

If the configured action is "SET NULL", then when a parent key is deleted (for ON DELETE

SET NULL) or modified (for ON UPDATE SET NULL), the child key columns of all rows in the child table that mapped to the parent key are set to contain SQL NULL values.

SET DEFAULT

The "SET DEFAULT" actions are similar to "SET NULL", except that each of the child key columns is set to contain the columns default value instead of NULL.

Navicat Win 493

Deferred

Deferred foreign key constraints are not checked until the transaction tries to COMMIT.

Navicat Win 494

SQLite Table Uniques

Unique constraints ensure that the data contained in a column or a group of columns is unique with respect to all the rows in the table.

Add Unique

To add an unique



Open the table in the Table Designer.

Open the Uniques tab.

Right-click and select the Add Unique from the popup menu or click the Add

Unique from the toolbar.

Edit unique properties.

Edit Unique

To edit an unique



Open the table in the Table Designer.

Open the Uniques tab.

Just simply click on the unique to edit.

Delete Unique

To delete an unique



Open the table in the Table Designer.

Open the Uniques tab.

Right-click on the unique to delete and select the Delete Unique from the popup menu or click the Delete Unique from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 495

Setting SQLite Table Unique Properties

Use the Name edit box to set the unique name.

Fields

To set field(s) as unique, just simply double-click the Fields field or click to open the editor(s) for editing.

Collation

To define a collating sequence used for text entries in that column. The default collating sequence is the collating sequence defined for that column.

BINARY

Compares string data using memcmp(), regardless of text encoding.

NOCASE

RTRIM

The same as binary, except that trailing space characters are ignored.

Note: Support in SQLite 3.

Navicat Win 496

Sort Order

To indicate sort order - ascending "ASC" or descending "DESC".

ON CONFLICT

To specify an algorithm used to resolve constraint conflicts. The default conflict resolution algorithm is ABORT.

ROLLBACK

When a constraint violation occurs, an immediate ROLLBACK occurs, thus ending the current transaction, and the command aborts with a return code of

SQLITE_CONSTRAINT. If no transaction is active (other than the implied transaction that is created on every command) then this algorithm works the same as ABORT.

ABORT

This is the default behavior.

FAIL

When a constraint violation occurs, the command aborts with a return code

IGNORE

Navicat Win 497

REPLACE

CHECK constraint violation occurs then the IGNORE algorithm is used.

Navicat Win 498

SQLite Table Checks

A check constraint allows you to specify that the value in a certain column must satisfy a

Boolean (truth-value) expression.

Note: Checks are supported from SQLite version 3.3.0 or later.

Add Check

To add a check



Open the table in the Table Designer.

Open the Checks tab.

Right-click and select the Add Check from the popup menu or click the Add

Check from the toolbar.

Edit check properties.

Edit Check

To edit a check



Open the table in the Table Designer.

Open the Checks tab.

Just simply click on the check to edit.

Delete Check

To delete a check



Open the table in the Table Designer.

Open the Checks tab.

Right-click on the check to delete and select the Delete Check from the popup menu or click the Delete Check from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 499

Setting SQLite Table Check Properties

Use the Name edit box to set the check name.

Check

Set the condition for checking, e.g. "field_name1 > 0 AND field_name2 > field_name1" in the Check edit box.

Definition

Type in the definition for the check constraint.

Navicat Win 500

SQLite Table Triggers

A trigger is a database operation that is automatically performed when a specified database event occurs.

Add Trigger

To add a trigger



Open the table in the Table Designer.

Open the Triggers tab.

Right-click and select the Add Trigger from the popup menu or click the Add

Trigger from the toolbar.

Edit trigger properties.

Edit Trigger

To edit a trigger



Open the table in the Table Designer.

Open the Triggers tab.

Just simply click on the trigger to edit.

Delete Trigger

To delete a trigger



Open the table in the Table Designer.

Open the Triggers tab.

Right-click on the trigger to delete and select the Delete Trigger from the popup menu or click the Delete Trigger from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 501

Setting SQLite Table Trigger Properties

Name

Set the trigger name.

Fires

Determine when the trigger actions will be executed relative to the insertion, modification or removal of the associated row.

INSERT

Fires the trigger whenever an INSERT statement adds a row to a table.

UPDATE

Fires the trigger whenever an UPDATE statement changes a value in one of the columns specified in Update of Fields. If no Update of Fields are present, the trigger will be fired whenever an UPDATE statement changes a value in any column of the table.

DELETE

Fires the trigger whenever a DELETE statement removes a row from the table.

Update of Fields

Specify the fields for UPDATE statement trigger upon necessary.

Definition

Type in the definition for the trigger.

Advanced

When Clause

Specify the trigger condition, which is a SQL condition that must be satisfied for the database to fire the trigger.

Navicat Win 502

SQLite Table Options

Table Options are managed on the Options tab of the Table Designer. Just simply click an option for editing.

Primary Key ON CONFLICT

To specify an algorithm used to resolve primary key constraint conflicts. The default conflict resolution algorithm is ABORT.

ROLLBACK

When a constraint violation occurs, an immediate ROLLBACK occurs, thus ending the current transaction, and the command aborts with a return code of

SQLITE_CONSTRAINT. If no transaction is active (other than the implied transaction that is created on every command) then this algorithm works the same as ABORT.

ABORT

This is the default behavior.

FAIL

When a constraint violation occurs, the command aborts with a return code

IGNORE

Navicat Win 503

REPLACE

CHECK constraint violation occurs then the IGNORE algorithm is used.

Auto Increment

Set/Reset the Auto Increment value in the edit field. The Auto Increment Value indicates the value for next record.

Navicat Win 504

SQLite Views

Views are useful for allowing users to access a set of tables as if it were a single table, and limiting their access to just that. Views can also be used to restrict access to rows (a subset of a particular table).

Just simply click to open an object pane for View. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit, open and delete the selected view.

Create View

To create a new view



Select anywhere on the object pane.

Click the New View from the object pane toolbar. or

Right-click and select New View from the popup menu.

Edit view properties on the appropriate tabs of the View Designer.

Hint: To create new view you can also right-click the Views node of the navigation pane and select the New View from the popup menu.

To create a new view with the same properties as one of the existing views has (using drag and drop method)

Apply to: current database {same connection}



Select the view(s) for copying in the navigation pane/object pane.

Right-click and drag the chosen view(s) to the target location.

Select one of the following options: o

Copy here (Structure and Data) o o

Copy here (Structure only)

Move here o

Cancel

The newly created view(s) will be named as "viewname_copy".

Navicat Win 505

Apply to: different database {same connection} different database {different connection} (Data Transfer tool will be activated)



Select the view(s) for copying in the object pane.

Drag and drop the chosen view(s) to the target database.

Select one of the following options: o o o

Copy here (Structure and Data)

Copy here (Structure only)

Cancel

To create a new view with modification as one of the existing views



Select the view for modifying in the navigation pane/object pane.

Right-click and select the Design View from the popup menu. or

Click the Design View from the object pane toolbar.

Modify view properties on the appropriate tabs of the View Designer.

Click Save As.

To create a new view with loading from a SQL file



Select anywhere on the object pane.

Click the New View from the object pane toolbar. or

Right-click and select New View from the popup menu.

Click Load.

Create View Shortcut

To create a view shortcut



Select the view for editing in the navigation pane/object pane.

Right-click and select Create Open View Shortcut... from the popup menu.

Define the location you wish your shortcut to be saved.

Note: This option is used to provide a convenient way for you to open your view for entering data directly (Grid View/Form View) without activating the main Navicat.

Navicat Win 506

Edit View

To edit the existing view (manage its SQL definition etc)



Select the view for editing in the navigation pane/object pane.

Right-click and select the Design View from the popup menu. or

Click the Design View from the object pane toolbar.

Edit view properties on the appropriate tabs of the View Designer.

To change the name of the view



Select the view for editing in the navigation pane/object pane.

Right-click and select the Rename from the popup menu.

Open View

To open a view (manage view data)



Select the view for opening in the navigation pane/object pane.

Right-click and select the Open View from the popup menu or simply double-click the view. or

Click the Open View from the object pane toolbar.

Delete View

To delete a view



Select the view for deleting in the navigation pane/object pane.

Right-click and select the Delete View from the popup menu. or

Click the Delete View from the object pane toolbar.

Confirm deleting in the dialog window.

Navicat Win 507

Achieve View Information

To achieve a view information



Select the view in the navigation pane/object pane.

Right-click the selected view and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 508

SQLite View Designer

View Designer is the basic Navicat tool for working with views. It allows you to create new view and edit the existing view definition (view name and the SELECT statement it implements).



View SQL Preview

Navicat Win 509

Working with SQLite View Builder (Available only in Full Version)

View Builder allows you to build views visually. It allows you to create and edit views without knowledge of SQL. See Query Builder for details.

Navicat Win 510

Editing SQLite View SQL Definition

The Definition tab allows you to edit the view definition as SQL statement (SELECT statement it implements).

Example:

SELECT

clients.RecordID

FROM

clients

Hint: To customize the view of the editor and find out more features for sql editing, see Editor

View and More Features.

Navicat Win 511

SQLite View Preview

To preview the result of the view, click Preview on the toolbar. If the query statement is correct, the Result and Message tabs will be opened.

The Result tab displays the data of the view as a grid and the Message tab displays the message log.

Navicat Win 512

SQLite View Explain

To return information about how the SQL statement would have operated, click Explain on the toolbar. If the query statement is correct, the Explain tab will show.

Navicat Win 513

SQLite View Viewer

View Viewer displays the view data as a grid. Data can be displayed in three modes:

Grid View, Form View and Text/Blob View. See Data View for details.

The toolbars of View Viewer provides the following functions for managing data:

 Export Data

Export data to MS Word, MS Excel, MS Access, TXT, DBF, HTML, SQL, RTF and more.

 Filter Data

Allow you to filter records by creating and applying filter criteria for the data grid.

 Edit TEXT/BLOB

Allow you to view and edit the content of TEXT and BLOB fields.

Navicat Win 514

SQLite Indexes

Index provides a faster access path to table data. It is created using one or more columns of a table to speed SQL statement execution on that table.

Just simply click to open an object pane for Index. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected

Index.

Create Index

To create a new index



Select anywhere on the object pane.

Click the New Index from the object pane toolbar. or

Right-click and select New Index from the popup menu.

Edit index properties on the appropriate tabs of the Index Designer.

To create a new index with modification as one of the existing index



Select the index for modifying in the object pane.

Right-click and select the Design Index from the popup menu or simply double-click the index. or

Click the Design Index from the object pane toolbar.

Modify index properties on the appropriate tabs of the Index Designer.

Click Save As.

Edit Index

To edit the existing index (manage its properties etc)



Select the index for editing in the object pane.

Right-click and select the Design Index from the popup menu or simply double-click the index. or

Click the Design Index from the object pane toolbar.

Edit index properties on the appropriate tabs of the Index Designer.

Navicat Win 515

To change the name of the index



Select the index for editing in the object pane.

Right-click and select the Rename from the popup menu.

Maintain Index

To maintain an index



Select the index for maintaining in the object pane.

Right-click and select the Maintain from the popup menu. o

ReIndex

Delete Index

To delete an index



Select the index for deleting in the object pane.

Right-click and select the Delete Index from the popup menu. or

Click the Delete Index from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Index Information

To achieve an index information (Index Owner, Index Type and DDL, etc)



Select the index in the object pane.

Right-click the selected index and choose Index Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 516

SQLite Index Designer

Index Designer is the basic Navicat tool for working with indexes. It allows you to create new index and edit the existing index properties.



Editing Index General

Index SQL Preview

Navicat Win 517

Editing SQLite Index General

Type

The types of the index.

Normal

A normal index does not impose restrictions on the column values.

Unique

An unique index indicates that no two rows of a table have duplicate values in the key columns.

Table name

The table that contains the index.

Fields

Name

To define the field.

Collate

To define a collating sequence used for text entries in that column. The default collating sequence is the collating sequence defined for that column.

BINARY

Compares string data using memcmp(), regardless of text encoding.

NOCASE

RTRIM

The same as binary, except that trailing space characters are ignored.

Note: Support in SQLite 3.

Sort Order

To indicate sort order - ascending "ASC" or descending "DESC".

Navicat Win 518

SQLite Triggers

Triggers are database operations that are automatically performed when a specified database event occurs.

Editing Trigger Definition

Just simply click to open an object pane for Trigger. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit and delete the selected trigger.

Create Trigger

To create a new trigger



Select anywhere on the object pane.

Click the New Trigger from the object pane toolbar. or

Right-click and select New Trigger from the popup menu.

Edit trigger properties on the appropriate tabs of the Trigger Designer.

To create a new trigger with modification as one of the existing trigger



Select the trigger for modifying in the object pane.

Right-click and select the Design Trigger from the popup menu or simply double-click the trigger. or

Click the Design Trigger from the object pane toolbar.

Modify trigger properties on the appropriate tabs of the Trigger Designer.

Click Save As.

Navicat Win 519

Edit Trigger

To edit the existing trigger (manage its general, advance, etc)



Select the trigger for editing in the object pane.

Right-click and select the Design Trigger from the popup menu or simply double-click the trigger. or

Click the Design Trigger from the object pane toolbar.

Edit trigger properties on the appropriate tabs of the Trigger Designer.

To change the name of the trigger



Select the trigger for editing in the object pane.

Right-click and select the Rename from the popup menu.

Delete Trigger

To delete a trigger



Select the trigger for deleting in the object pane.

Right-click and select the Delete Trigger from the popup menu. or

Click the Delete Trigger from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Trigger Information

To achieve a trigger information (Trigger Owner, DB Link and DDL, etc)



Select the trigger in the object pane.

Right-click the selected trigger and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 520

SQLite Trigger Designer

Trigger Designer is the basic Navicat tool for working with triggers. It allows you to create new trigger and edit the existing trigger definition.



Editing Trigger General

Trigger SQL Preview

Navicat Win 521

Editing SQLite Trigger General

Trigger Type

Define the trigger type: TABLE or VIEW.

Table name or View name

Choose a table or view.

Fires

Determine when the trigger actions will be executed relative to the insertion, modification or removal of the associated row.

When

Specify the trigger condition for the database to fire the trigger.

On Event

It indicates the kind of statement that activates the trigger.

Insert

The trigger is activated whenever adding a row to a table.

Delete

The trigger is activated whenever removing a row from the table.

Update

The trigger is activated whenever changing a value in one of the fields selected in

Update Of Fields.

Update of Fields

Specify the fields for UPDATE statement trigger upon necessary.

Navicat Win 522

Editing SQLite Trigger Definition

The Definition tab allows you to edit valid SQL statements in the trigger definition inside

BEGIN and END.

Navicat Win 523

SQL Server Database Object Management

The following list contains the most common SQL Server database objects supported by

Navicat.



Navicat Win 524

SQL Server Schemas

A schema contains named objects (tables, views, functions, etc) whose names may duplicate those of other objects existing in other schemas.

The schema name must be distinct from any existing schema name in the current database.

Create Schema

Note: Support from SQL Server 2005 or later and SQL Azure.

To create a new schema



Right-click the database in the navigation pane and choose New Schema.... or

Right-click any existing schema and choose New Schema....

Edit schema properties on the appropriate tabs of the Schema Designer.

Edit Schema

Note: Support from SQL Server 2005 or later and SQL Azure.

To edit the existing schema(manage its general etc)



Right-click the schema in the navigation pane and choose Schema Properties....

Edit schema properties on the appropriate tabs of the Schema Designer.

Open Schema

To open a schema which shows in the navigation pane



Double-click the schema to open in the navigation pane. or

Right-click the schema and choose Open Schema.

Close Schema

To close a schema

 Right-click the schema in the navigation pane and choose Close Schema.

Navicat Win 525

Delete Schema

Note: Support from SQL Server 2005 or later and SQL Azure.

To delete a schema



Right-click the schema in the navigation pane and choose Delete Schema.

Confirm deleting in the dialog window.

Navicat Win 526

SQL Server Schema Designer

Schema Designer is the basic Navicat tool for working with schema. It allows you to create new schema and edit the existing schema properties.

Note: Support from SQL Server 2005 or later and SQL Azure.



Editing Schema General

Editing Schema Comment (SQL Azure does not support)

Schema SQL Preview

Navicat Win 527

Editing SQL Server Schema General

Schema Name

The name of a schema which is identified within the database.

Owner

The name of the database-level principal that will own the schema. This principal may own other schemas, and may not use the current schema as its default schema.

Navicat Win 528

SQL Server Tables

Tables are database objects that contain all the data in a database. A table definition is a collection of columns. In tables, data is organized in a row-and-column format similar to a spreadsheet. Each row represents a unique record, and each column represents a field within the record.

Just simply click to open an object pane for Table. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit, open and delete the selected table.

Create Table

To create a new table



Select anywhere on the object pane.

Click the New Table from the object pane toolbar. or

Right-click and select New Table from the popup menu.

Edit table properties and fields on the appropriate tabs of the Table Designer.

Hint: To create new table you can also right-click the Tables node of the navigation pane and select the New Table from the popup menu.

To create a new table with the same properties as one of the existing tables has (using popup menu)

Apply to: current database {same connection}



Select the table(s) for copying in the navigation pane/object pane.

Right-click and select the Duplicate Table from the popup menu.

The newly created table(s) will be named as "tablename_copy".

Navicat Win 529

To create a new table with the same properties as one of the existing tables has (using drag and drop method)

Apply to: current database {same connection}



Select the table(s) for copying in the navigation pane/object pane.

Right-click and drag the chosen table(s) to the target location.

Select one of the following options: o

Copy here (Structure and Data) o o

Copy here (Structure only)

Move here o

Cancel

The newly created table(s) will be named as "tablename_copy"

Apply to: different database {same connection} different database {different connection (same or cross server type)} (Data Transfer tool will be activated)



Select the table(s) for copying in the object pane.

Drag and drop the chosen table(s) to the target database.

Select one of the following options: o o o

Copy here (Structure and Data)

Copy here (Structure only)

Cancel

To create a new table with modification as one of the existing tables



Select the table for modifying in the navigation pane/object pane.

Right-click and select the Design Table from the popup menu. or

Click the Design Table from the object pane toolbar.

Modify table properties and fields on the appropriate tabs of the Table Designer.

Click Save As.

Navicat Win 530

Create Table Shortcut

To create a table shortcut



Select the table for editing in the navigation pane/object pane.

Right-click and select Create Open Table Shortcut... from the popup menu.

Define the location you wish your shortcut to be saved.

Note: This option is used to provide a convenient way for you to open your table for entering data directly (Grid View/Form View) without activating the main Navicat.

Edit Table

To edit the existing table (manage its fields, indexes, foreign keys and triggers etc)



Select the table for editing in the navigation pane/object pane.

Right-click and select the Design Table from the popup menu. or

Click the Design Table from the object pane toolbar.

Edit table properties and fields on the appropriate tabs of the Table Designer.

To change the name of the table



Select the table for editing in the navigation pane/object pane.

Right-click and select the Rename from the popup menu.

Open Table (manage table data)

To open a table



Select the table for opening in the navigation pane/object pane.

Right-click and select the Open Table from the popup menu or simply double-click the table. or

Click the Open Table from the object pane toolbar.

Note: This option is only applied if you do wish Navicat loads all your images while opening the table. To open the graphical table with faster performance, use Open

Table (Quick) below.

Navicat Win 531

To open a table with graphical fields



Select the table for opening in the navigation pane/object pane.

Right-click and select the Open Table (Quick) from the popup menu.

Note: Faster performance for opening the graphical table, as BLOB fields (images) will not be loaded until you click on the cell.

Empty Table

To empty a table



Select the table in the navigation pane/object pane.

Right-click the selected table and choose Empty Table from the popup menu.

Delete Table

To delete a table



Select the table for deleting in the navigation pane/object pane.

Right-click and select the Delete Table from the popup menu. or

Click the Delete Table from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Table Information

To achieve a table information



Select the table in the navigation pane/object pane.

Right-click the selected table and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 532

SQL Server Table Designer

Table Designer is the basic Navicat tool for working with tables. It allows you to create, edit and drop table's fields, indexes, foreign keys, and much more.



Managing Table Storage

Managing Table Comment (SQL Azure does not support)

Table SQL Preview

Navicat Win 533

SQL Server Table Fields

Add Field

To add a field to the table



Open the table in the Table Designer.

Open the Fields tab.

Right-click and select the Add Field from the popup menu or click the Add Field from the toolbar.

Edit field properties.

To add a new field with modification as one of the existing fields



Open the table in the Table Designer.

Open the Fields tab.

Select field.

Right-click and select the Duplicate Field from the popup menu.

Edit field properties.

Edit Field

To edit the table field



Open the table in the Table Designer.

Open the Fields tab.

Simply click on the field to edit.

Navicat Win 534

Delete Field

To delete the table field



Open the table in the Table Designer.

Open the Fields tab.

Right-click on the field to delete and select the Delete Field from the popup menu or click the Delete Field from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 535

Setting SQL Server Table Field Properties

Name

The Name is a descriptive identifier for a field that can be up to 128 characters. The names should be descriptive enough that anyone can easily identify them when viewing or editing records. For example, LastName, FirstName, StreetAddress, or HomePhone.

Use the Name edit box to set the field name. Note that the name of the field must be unique among all the field names in the table.

Type

After you name a field, you choose a data type for the data to be contained in the field. When you choose a field's data type, you are deciding:



 What kind of values to allow in the field. You cannot store text in field with the

Numeric data type.

How much storage space SQL Server is to set aside for the data in that field.

What types of operations can be performed on the values in that field.

The Type dropdown list defines the type of the field data. See SQL Server Data Type and SQL

Azure Support Data Type for details.

Length and Scale

Use the Length edit box to define the length of the field and use Scale edit box to define the number of digits after the decimal point (the scale) for Floating Point data type.

Note: Be careful when shortening the field length as losing data might be caused.

Allow Null

Allow the NULL values for the field.

Navicat Win 536

Primary Key

A Primary Key is a single field or combination of fields that uniquely defines a record. None of the fields that are part of the primary key can contain a null value.

Primary Key Name

Right-click and select Primary Key Name from the popup menu to enter the primary key constraint name.

Fill Factor

Right-click and select Fill Factor from the popup menu to specify how full the Database

Engine should make each index page that is used to store the index data. User-specified fillfactor values can be from 1 through 100.

Design Primary Key Index

Right-click and select Design Primary Key Index from the popup menu to design primary key index.

Navicat Win 537

Setting Other SQL Server Table Field Properties

For bigint, decimal, int, numeric, smallint, tinyint data types:

Identity

Indicate that the new column is an identity column.

For uniqueidentifier data types:

Row GUID

Indicate that the new column is a row GUID column. Only one uniqueidentifier column per table can be designated as the ROWGUIDCOL column.

Note: SQL Azure does not support.

For char, nchar, ntext, nvarchar, text, varchar data types:

Collation

Specify the collation for the column.

For xml data types:

Column Set For All Sparse Columns

Combine all of the sparse columns of a table into a structured output.

Note: Support from SQL Server 2008 or later.

For varbinary(MAX) data types:

File Stream

Specify FILESTREAM storage for the varbinary(max) BLOB data.

Note: Support from SQL Server 2008 or later.

For User Defined Type data types:

User Defined Type Schema

Set the schema of the user defined type.

User Defined Type

Set the user defined type.

Navicat Win 538

For Computed Column data types:

Computed Expression

Set an expression that defines the value of a computed column.

Persisted

Specify that the SQL Server Database Engine will physically store the computed values in the table, and update the values when any other columns on which the computed column depends are updated.

For most data types:

Default

Set the default value for the field.

With Values

Check this to enable the with values option.

Sparse

Indicate that the column is a sparse column.

Note: Support from SQL Server 2008 or later.

For all data types:

Comment

Set any optional text describing the current field.

Note: SQL Azure does not support.

Navicat Win 539

SQL Server Table Indexes

Indexes are optional structures associated with tables. You can create indexes on one or more columns of a table to speed SQL statement execution on that table.

Add Index

To add a table index



Open the table in the Table Designer.

Open the Indexes tab.

Right-click and select the Add Index from the popup menu or click the Add

Index from the toolbar.

Edit index properties.

Edit Index

To edit a table index



Open the table in the Table Designer.

Open the Indexes tab.

Just simply click/double-click on the index to edit.

Delete Index

To delete a table index



Open the table in the Table Designer.

Open the Indexes tab.

Right-click on the index to delete and select the Delete Index from the popup menu or click the Delete Index from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 540

Setting SQL Server Table Index Properties

Use the Name edit box to set the index name.

To include field(s) in the index, just simply double-click the Fields field or click to open the editor for editing.

Select the field(s) from the list. To remove the fields from the index, uncheck them in the same way. You can also use the arrow buttons to change the index field(s) order. The Order dropdown list is used to set sort direction.

Note: Some of data types do not allow indexing. For example: text

The Index Type dropdown list defines the type of the table index.

Clustered

Create an index in which the logical order of the key values determines the physical order of the corresponding rows in a table.

Non-Clustered

Create an index that specifies the logical ordering of a table. With a nonclustered index, the physical order of the data rows is independent of their indexed order.

Navicat Win 541

Spatial

Create a spatial index on a specified table and column. An index can be created before there is data in the table.

Note: Support from SQL Server 2008 or later and SQL Azure.

XML

Create an XML index on a specified table. An index can be created before there is data in the table.

Note: Support from SQL Server 2005 or later.

Unique

Create a unique index on a table.

Comment

Specify the comment of the index.

Note: SQL Azure does not support.

Navicat Win 542

SQL Server Table Foreign Keys

A foreign key is a field in a relational table that matches the primary key column of another table. The foreign key can be used to cross-reference tables.

Add Foreign Key

To add a foreign key



Open the table in the Table Designer.

Open the Foreign Keys tab.

Right-click and select the Add Foreign Key from the popup menu or click the

Add Foreign Key from the toolbar.

Edit foreign key properties.

Edit Foreign Key

To edit a foreign key



Open the table in the Table Designer.

Open the Foreign Keys tab.

Just simply click/double-click on the foreign key to edit.

Delete Foreign Key

To delete a foreign key



Open the table in the Table Designer.

Open the Foreign Keys tab.

Right-click on the foreign key to delete and select the Delete Foreign Key from the popup menu or click the Delete Foreign Key from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 543

Setting SQL Server Table Foreign Key Properties

Use the Name edit box to enter a name for the new key and then select a table field to include in the key from the Fields group.

Use the Reference Schema and Reference Table dropdown lists to select a foreign schema and table respectively.

To include field(s) to the key, just simply double-click the Fields/Reference Fields field or click to open the editor(s) for editing.

The On Delete and On Update dropdown list define the type of the actions to be taken.

No Action

The Database Engine raises an error and the delete or update action on the row in the parent table is rolled back.

Cascade

Corresponding rows are deleted from or updated in the referencing table if that row is deleted from or updated in the parent table.

Set Null

All the values that make up the foreign key are set to NULL when the corresponding row in the parent table is deleted or updated.

Set Default

All the values that make up the foreign key are set to their default values when the corresponding row in the parent table is deleted or updated.

Enable

You can choose whether to enable / disable the foreign key constraint by checking / unchecking the box.

Navicat Win 544

Not For Replication

The constraint is not enforced when replication agents perform insert, update, or delete operations.

Note: SQL Azure does not support.

Comment

Specify the comment of the foreign key.

Note: SQL Azure does not support.

Navicat Win 545

SQL Server Table Uniques

Unique constraints ensure that the data contained in a column or a group of columns is unique with respect to all the rows in the table.

Add Unique

To add an unique



Open the table in the Table Designer.

Open the Uniques tab.

Right-click and select the Add Unique from the popup menu or click the Add

Unique from the toolbar.

Edit unique properties.

Edit Unique

To edit an unique



Open the table in the Table Designer.

Open the Uniques tab.

Just simply click on the unique to edit.

Delete Unique

To delete an unique



Open the table in the Table Designer.

Open the Uniques tab.

Right-click on the unique to delete and select the Delete Unique from the popup menu or click the Delete Unique from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 546

Setting SQL Server Table Unique Properties

Use the Name edit box to set the unique name.

Fields

To set field(s) as unique, just simply double-click the Fields field or click to open the editor(s) for editing.

Clustered

Indicate that a clustered index is created for the unique constraint.

Comment

Specify the comment of the unique.

Note: SQL Azure does not support.

Navicat Win 547

SQL Server Table Checks

A check a constraint that enforces domain integrity by limiting the possible values that can be entered into a column or columns.

Add Check

To add a check



Open the table in the Table Designer.

Open the Checks tab.

Right-click and select the Add Check from the popup menu or click the Add

Check from the toolbar.

Edit check properties.

Edit Check

To edit a check



Open the table in the Table Designer.

Open the Checks tab.

Just simply click on the check to edit.

Delete Check

To delete a check



Open the table in the Table Designer.

Open the Checks tab.

Right-click on the check to delete and select the Delete Check from the popup menu or click the Delete Check from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 548

Setting SQL Server Table Check Properties

Use the Name edit box to set the check name.

Check

Set the logical expression that returns TRUE or FALSE, e.g. "field_name1 > 0 AND field_name2 > field_name1" in the Check edit box.

Enable

You can choose whether to enable / disable the check constraint by checking / unchecking the box.

Not For Replication

The constraint is not enforced when replication agents perform insert, update, or delete operations.

Note: SQL Azure does not support.

Definition

Type in the definition for the check constraint.

Comment

Specify the comment of the check.

Note: SQL Azure does not support.

Navicat Win 549

SQL Server Table Triggers

A trigger is a special kind of stored procedure that automatically executes when an event occurs in the database server.

Add Trigger

To add a trigger



Open the table in the Table Designer.

Open the Triggers tab.

Right-click and select the Add Trigger from the popup menu or click the Add

Trigger from the toolbar.

Edit trigger properties.

Edit Trigger

To edit a trigger



Open the table in the Table Designer.

Open the Triggers tab.

Just simply click on the trigger to edit.

Delete Trigger

To delete a trigger



Open the table in the Table Designer.

Open the Triggers tab.

Right-click on the trigger to delete and select the Delete Trigger from the popup menu or click the Delete Trigger from the toolbar.

Confirm deleting in the dialog window.

Navicat Win 550

Setting SQL Server Table Trigger Properties

Use the Name edit box to set the trigger name.

Use the Fires dropdown list to define the trigger action time.

AFTER

Specify that the DML trigger is fired only when all operations specified in the triggering

SQL statement have executed successfully.

INSTEAD OF

Specify that the DML trigger is executed instead of the triggering SQL statement, therefore, overriding the actions of the triggering statements.

Insert

The trigger is activated whenever a new row is inserted into the table.

Update

The trigger is activated whenever a row is modified.

Delete

The trigger is activated whenever a row is deleted from the table.

Enable

You can choose whether to enable / disable the trigger constraint by checking / unchecking the box.

Advanced

Execute As

Specify the security context under which the trigger is executed.

Note: Support from SQL Server 2005 or later and SQL Azure.

Navicat Win 551

User

Choose a user that the trigger executes in.

Note: Support from SQL Server 2005 or later and SQL Azure.

Encrypted

Obfuscate the text of the CREATE TRIGGER statement.

Note: Support from SQL Server 2005 or later.

Not For Replication

Indicate that the trigger should not be executed when a replication agent modifies the table that is involved in the trigger.

Note: SQL Azure does not support.

With Append

Specify that an additional trigger of an existing type should be added.

Note: SQL Azure does not support.

Definition Type

Choose the type of definition.

Note: Support from SQL Server 2005 or later.

Comment

Specify the comment of the trigger.

Note: SQL Azure does not support.

Navicat Win 552

SQL Server Table Options

Table Lock Escalation

Specify the allowed methods of lock escalation for a table.

Note: Support from SQL Server 2008 or later.

Identity Seed

The value used for the very first row loaded into the table.

Identity Increment

The incremental value added to the identity value of the previous row loaded.

Current Identity Value

Set the current identity value.

Note: SQL Azure does not support.

Not For Replication

Values are not incremented in identity columns when replication agents perform inserts.

Note: SQL Azure does not support.

Change Tracking Enabled

Specify change tracking is enabled for the table.

Note: Support from SQL Server 2008 or later.

Track Columns Updated

Specify the Database Engine tracks which change tracked columns were updated.

Note: Support from SQL Server 2008 or later.

Navicat Win 553

SQL Server Table Storage

SQL Azure does not support this tab.

On Filegroup

Filegroup

Choose a filegroup that storing the table.

Text/Image Filegroup

Choose a filegroup for storing text, ntext, image, xml, varchar(max), nvarchar(max), varbinary(max), and CLR user-defined type columns.

File Stream Filegroup

Choose a filegroup for FILESTREAM data.

Note: Support from SQL Server 2008 or later.

On Partition Scheme

Note: Support from SQL Server 2005 or later.

Partition Scheme

Choose a partition scheme that storing the table.

Partition Column

Choose a partition column name.

File Stream Partition Scheme

Choose a partition scheme for FILESTREAM data.

Note: Support from SQL Server 2008 or later.

Data Compression

Note: Support from SQL Server 2008 or later.

Partition Number

The partition which the DATA_COMPRESSION setting applies.

Navicat Win 554

Type

NONE

Table or specified partitions are not compressed.

ROW

Table or specified partitions are compressed by using row compression.

PAGE

Table or specified partitions are compressed by using page compression.

Navicat Win 555

SQL Server Views

A view can be thought of as either a virtual table or a stored query. Unless a view is indexed, its data is not stored in the database as a distinct object. What is stored in the database is a

SELECT statement. The result set of the SELECT statement forms the virtual table returned by the view. A user can use this virtual table by referencing the view name in Transact-SQL statements the same way a table is referenced.

Just simply click to open an object pane for View. A right-click displays the popup menu or using the object pane toolbar, allowing you to create new, edit, open and delete the selected view.

Create View

To create a new view



Select anywhere on the object pane.

Click the New View from the object pane toolbar. or

Right-click and select New View from the popup menu.

Edit view properties on the appropriate tabs of the View Designer.

Hint: To create new view you can also right-click the Views node of the navigation pane and select the New View from the popup menu.

To create a new view with the same properties as one of the existing views has (using drag and drop method)

Apply to: current database {same connection}



Select the view(s) for copying in the navigation pane/object pane.

Right-click and drag the chosen view(s) to the target location.

Select one of the following options: o

Copy here (Structure and Data) o o

Copy here (Structure only)

Move here o

Cancel

The newly created view(s) will be named as "viewname_copy".

Navicat Win 556

Apply to: different database {same connection} different database {different connection} (Data Transfer tool will be activated)



Select the view(s) for copying in the object pane.

Drag and drop the chosen view(s) to the target database.

Select one of the following options: o o o

Copy here (Structure and Data)

Copy here (Structure only)

Cancel

To create a new view with modification as one of the existing views



Select the view for modifying in the navigation pane/object pane.

Right-click and select the Design View from the popup menu. or

Click the Design View from the object pane toolbar.

Modify view properties on the appropriate tabs of the View Designer.

Click Save As.

To create a new view with loading from a SQL file



Select anywhere on the object pane.

Click the New View from the object pane toolbar. or

Right-click and select New View from the popup menu.

Click Load.

Create View Shortcut

To create a view shortcut



Select the view for editing in the navigation pane/object pane.

Right-click and select Create Open View Shortcut... from the popup menu.

Define the location you wish your shortcut to be saved.

Note: This option is used to provide a convenient way for you to open your view for entering data directly (Grid View/Form View) without activating the main Navicat.

Navicat Win 557

Edit View

To edit the existing view (manage its SQL definition etc)



Select the view for editing in the navigation pane/object pane.

Right-click and select the Design View from the popup menu. or

Click the Design View from the object pane toolbar.

Edit view properties on the appropriate tabs of the View Designer.

To change the name of the view



Select the view for editing in the navigation pane/object pane.

Right-click and select the Rename from the popup menu.

Open View

To open a view (manage view data)



Select the view for opening in the navigation pane/object pane.

Right-click and select the Open View from the popup menu or simply double-click the view. or

Click the Open View from the object pane toolbar.

Delete View

To delete a view



Select the view for deleting in the navigation pane/object pane.

Right-click and select the Delete View from the popup menu. or

Click the Delete View from the object pane toolbar.

Confirm deleting in the dialog window.

Navicat Win 558

Achieve View Information

To achieve a view information



Select the view in the navigation pane/object pane.

Right-click the selected view and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 559

SQL Server View Designer

View Designer is the basic Navicat tool for working with views. It allows you to create new view and edit the existing view definition (view name and the SELECT statement it implements).



Editing View Comment (SQL Azure does not support)

View SQL Preview

Setting Parameters for Procedure/Function

Navicat Win 560

Working with SQL Server View Builder (Available only in Full Version)

View Builder allows you to build views visually. It allows you to create and edit views without knowledge of SQL. See Query Builder for details.

Navicat Win 561

Editing SQL Server View SQL Definition

The Definition tab allows you to edit the view definition as SQL statement (SELECT statement it implements).

Example:

SELECT

report_sample.clients.RecordID

FROM

report_sample.clients

Hint: To customize the view of the editor and find out more features for sql editing, see Editor

View and More Features.

Navicat Win 562

Setting Advanced SQL Server View Properties

Encrypted

Encrypt the entries in sys.syscomments that contain the text of the CREATE VIEW statement.

Note: SQL Azure does not support.

Schema Bound

Bind the view to the schema of the underlying table or tables.

View Metadata

Specify that the instance of SQL Server will return to the DB-Library, ODBC, and OLE DB APIs the metadata information about the view, instead of the base table or tables, when browse-mode metadata is being requested for a query that references the view.

With Check Option

Force all data modification statements executed against the view to follow the criteria set within select_statement.

Navicat Win 563

SQL Server View Preview

To preview the result of the view, click Preview on the toolbar. If the query statement is correct, the Result and Message tabs will be opened.

The Result tab displays the data of the view as a grid and the Message tab displays the message log.

Navicat Win 564

SQL Server View Explain

To return information about how the SQL statement would have operated, click Explain on the toolbar. If the query statement is correct, the Explain tab will show.

The Explain tab displays the information as a grid:

StmtText

StmtId

NodeId

Parent

Column

PhysicalOp

LogicalOp

Argument

DefinedValues

EstimateRows

EstimateIO

Description

For rows that are not of type PLAN_ROW, this column contains the text of the Transact-SQL statement. For rows of type PLAN_ROW, this column contains a description of the operation. This column contains the physical operator and may optionally also contain the logical operator. This column may also be followed by a description that is determined by the physical operator.

Number of the statement in the current batch.

ID of the node in the current query.

Node ID of the parent step.

Physical implementation algorithm for the node. For rows of type PLAN_ROWS only.

Relational algebraic operator this node represents. For rows of type PLAN_ROWS only.

Provides supplemental information about the operation being performed. The contents of this column depend on the physical operator.

Contains a comma-separated list of values introduced by this operator. These values may be computed expressions which were present in the current query (for example, in the SELECT list or WHERE clause), or internal values introduced by the query processor in order to process this query. These defined values may then be referenced elsewhere within this query. For rows of type PLAN_ROWS only.

Estimated number of rows of output produced by this operator. For rows of type PLAN_ROWS only.

Estimated I/O cost* for this operator. For rows of type

PLAN_ROWS only.

Navicat Win 565

EstimateCPU

AvgRowSize

TotalSubtreeCost

OutputList

Warnings

Type

Estimated CPU cost* for this operator. For rows of type

PLAN_ROWS only.

Estimated average row size (in bytes) of the row being passed through this operator.

Estimated (cumulative) cost* of this operation and all child operations.

Contains a comma-separated list of columns being projected by the current operation.

Contains a comma-separated list of warning messages relating to the current operation. Warning messages may include the string "NO STATS:()" with a list of columns.

This warning message means that the query optimizer attempted to make a decision based on the statistics for this column, but none were available. Consequently, the query optimizer had to make a guess, which may have resulted in the selection of an inefficient query plan.

Node type. For the parent node of each query, this is the

Transact-SQL statement type (for example, SELECT,

INSERT, EXECUTE, and so on). For subnodes representing execution plans, the type is PLAN_ROW.

Parallel

EstimateExecutions

0 = Operator is not running in parallel.

1 = Operator is running in parallel.

Estimated number of times this operator will be executed while running the current query.

* Cost units are based on an internal measurement of time, not wall-clock time. They are used for determining the relative cost of a plan in comparison to other plans.

Navicat Win 566

SQL Server View Viewer

View Viewer displays the view data as a grid. Data can be displayed in three modes:

Grid View, Form View and Text/Blob View. See Data View for details.

The toolbars of View Viewer provides the following functions for managing data:

 Commit

Make permanent all changes performed in the transaction.

Hint: The Commit button is visible only when Auto Commit is disabled under

Option Settings.

 Rollback

Undo work done in the current transaction.

Hint: The Rollback button is visible only when Auto Commit is disabled under

Option Settings.

 Export Data

Export data to MS Word, MS Excel, MS Access, TXT, DBF, HTML, SQL, RTF and more.

 Filter Data

Allow you to filter records by creating and applying filter criteria for the data grid.

 Edit TEXT/BLOB

Allow you to view and edit the content of TEXT and BLOB fields.

Navicat Win 567

Navicat Win 568

SQL Server Functions/Procedures

A user-defined function, which is a Transact-SQL or common language runtime (CLR) routine that accepts parameters, performs an action, such as a complex calculation, and returns the result of that action as a value. The return value can either be a scalar (single) value or a table.

Stored procedures are similar to procedures in other programming languages in that they can:



Accept input parameters and return multiple values in the form of output parameters to the calling procedure or batch.

Contain programming statements that perform operations in the database, including calling other procedures.

Return a status value to a calling procedure or batch to indicate success or failure (and the reason for failure).

Create Function/Procedure

To create a new function/procedure



Select anywhere on the object pane.

Click the New Function from the object pane toolbar. or

Right-click and select New Function from the popup menu.

Edit function/procedure properties on the appropriate tabs of the Function/Procedure

Designer.

Hint: To create new function/procedure you can also right-click the Function node of the navigation pane and select the New Function from the popup menu.

Navicat Win 569

To create a new function/procedure with the same properties as one of the existing function/procedure has (using drag and drop method)

Apply to: current schema {same connection}



Select the function/procedure(s) for copying in the navigation pane/object pane.

Right-click and drag the chosen function/procedure(s) to the target location.

Select one of the following options: o

Copy here (Structure and Data) o o

Copy here (Structure only)

Move here o

Cancel

The newly created function/procedure(s) will be named as

"function/procedurename_copy".

Apply to: different schema {same connection} different schema {different connection} (Data Transfer tool will be activated)



Select the function/procedure(s) for copying in the object pane.

Drag and drop the chosen function/procedure(s) to the target database.

Select one of the following options: o o o

Copy here (Structure and Data)

Copy here (Structure only)

Cancel

Edit Function/Procedure

To edit the existing function/procedure



Select the function/procedure for editing in the navigation pane/object pane.

Right-click and select the Design Function from the popup menu or simply double-click the function/ procedure. or

Click the Design Function from the object pane toolbar.

Edit function/procedure properties on the appropriate tabs of the Function/Procedure

Designer.

Navicat Win 570

Run Function/Procedure

To run a function/procedure in the navigation pane/object pane



Select the function/procedure for executing in the navigation pane/object pane.

Click the Execute Function from the object pane toolbar. or

Right-click and select Execute Function from the popup menu.

View the returned data on the Result tab.

To run a function/procedure in the Function/Procedure Designer



Create a new function/procedure or open the existing function/procedure.

Click Run.

View the returned data on the Result tab.

Delete Function/Procedure

To delete a function/procedure



Select the function/procedure for deleting in the navigation pane/object pane.

Right-click and select the Delete Function from the popup menu. or

Click the Delete Function from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Function/Procedure Information

To achieve a function/procedure information



Select the function/procedure in the navigation pane/object pane.

Right-click the selected function/procedure and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 571

SQL Server Function Wizard

Click the New Function from the object pane toolbar. The Function Wizard will pop up and it allows you to create a procedure/function easily.



Setting Routine Type

Setting Options for Procedure/Function

You are allowed not to show the Function Wizard when create new procedure/function.

Hint: Once uncheck the Show wizard next time, you can go to Options to enable it.

Navicat Win 572

Setting SQL Server Routine Type

Specify the Name of the routine.

Select the type of the routine: Procedure or Function

Navicat Win 573

Setting Parameters for SQL Server Procedure/Function

Procedure

Define the parameter(s) of the procedure. Set the parameter Name, Type Schema,

Type, Default Value, Output and Read Only under corresponding columns.

Function

Define the parameter(s) of the function. Set the parameter Name, Type Schema,

Type, Default Value and Read Only under corresponding columns.

Navicat Win 574

Setting Return Type for SQL Server Function

Select the Function type from the dropdown list.

Then, choose the Schema and the Return Type from the list if necessary.

Note: Only function supports return type.

Navicat Win 575

Setting Options for SQL Server Procedure/Function

Encryption

The database will convert the CREATE statement to an obfuscated format.

Note: SQL Azure does not support.

Recompile

Instruct the database not to cache a plan for the procedure.

Note: Available only for procedure.

Schema binding

The function is bound to the database objects that it references.

Note: Available only for function.

NULL on NULL Input

Indicate the server can return null without invoking the function body.

Note: Available only for function and support from SQL Server 2005 or later.

Execute As

Specify the runtime user of the function.

Note: Support from SQL Server 2005 or later and SQL Azure.

For replication

Stored procedures created for repliction cannot be executed on the Subscriber.

Note: Available only for procedure and SQL Azure does not support.

Navicat Win 576

SQL Server Function/Procedure Designer

Function/Procedure Designer allows you to edit the existing function/procedure definition and more.



Editing Function/Procedure Definition

Editing Function/Procedure Comment (SQL Azure does not support)

Function/Procedure SQL Preview

Viewing Function/Procedure Result

Navicat Win 577

Editing SQL Server Function/Procedure Definition

Edit the function/procedure definition under the Definition tab.

The Code Outline window displays information about the function/procedure including parameter, code body, etc. To show the Code Outline window, simply choose View -> Code

Outline.

Note: Available only in Full Version.

Refresh the code outline.

Show the detail view of the code outline.

Turn mouse over highlight on or off.

Expand the selected item.

Collapse the selected item.

Toggle sorting by position.

Example:

CREATE PROCEDURE [schemaname].

BEGIN

-- routine body goes here, e.g.

-- SELECT 'Navicat for SQL Server'

END

Hint: To customize the view of the editor and find out more features for sql editing, see Editor

View and More Features.

Navicat Win 578

Viewing SQL Server Function/Procedure Result

To run the function/procedure click Run on the toolbar. If the SQL statement is correct, the statement will be executed and, if the statement is supposed to return data, the

Message and Result tabs open with the message log and data returned by the function/procedure. If an error occurs while executing the function/procedure, execution stops, the appropriate error message is displayed.

If the function/procedure requires input parameter, the Input Parameters box will popup.

Navicat Win 579

SQL Server Indexes

An index in a database lets you quickly find specific information in a table or indexed view. An index contains keys built from one or more columns in the table, or view, and pointers that map to the storage location of the specified data. You can significantly improve the performance of database queries and applications by creating well-designed indexes to support your queries. Indexes can reduce the amount of data that must be read to return the query result set. Indexes can also enforce uniqueness on the rows in a table, ensuring the data integrity of the table data.

Create Index

To create a new index



Select anywhere on the object pane.

Click the New Index from the object pane toolbar. or

Right-click and select New Index from the popup menu.

Edit index properties on the appropriate tabs of the Index Designer.

To create a new index with modification as one of the existing index



Select the index for modifying in the object pane.

Right-click and select the Design Index from the popup menu or simply double-click the index. or

Click the Design Index from the object pane toolbar.

Modify index properties on the appropriate tabs of the Index Designer.

Click Save As.

Navicat Win 580

Edit Index

To edit the existing index (manage its properties etc)



Select the index for editing in the object pane.

Right-click and select the Design Index from the popup menu or simply double-click the index. or

Click the Design Index from the object pane toolbar.

Edit index properties on the appropriate tabs of the Index Designer.

To change the name of the index



Select the index for editing in the object pane.

Right-click and select the Rename from the popup menu.

Maintain Index

To maintain an index



Select the index for maintaining in the object pane.

Right-click and select the Maintain from the popup menu. o o o

Rebuild

Reorganize

Disable

Delete Index

To delete an index



Select the index for deleting in the object pane.

Right-click and select the Delete Index from the popup menu. or

Click the Delete Index from the object pane toolbar.

Confirm deleting in the dialog window.

Navicat Win 581

Achieve Index Information

To achieve an index information



Select the index in the object pane.

Right-click the selected index and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 582

SQL Server Index Designer

Index Designer is the basic Navicat tool for working with indexes. It allows you to create new index and edit the existing index properties.



Editing Nonclustered Index Properties

Editing Clustered Index Properties

Editing XML Index Properties (Support from SQL Server 2005 or later)

Editing Spatial Index Properties (Support from SQL Server 2008 or later and SQL

Azure)

Editing Index Comment (SQL Azure does not support)

Index SQL Preview

Navicat Win 583

Editing SQL Server Nonclustered Index Properties

To create a nonclustered index:



Editing Nonclustered Index General

Editing Nonclustered Index Filter (Support from SQL Server 2008 or later and SQL

Azure)

Editing Advanced Nonclustered Index Properties

Editing Nonclustered Index Storage

Navicat Win 584

Editing SQL Server Nonclustered Index General

Type

Choose the index type: Nonclustered, Clustered, XML or Spatial

Unique

A unique index is one in which no two rows are permitted to have the same index key value.

Table / View

Choose to create a table index or a view index.

Table name or View Name

Select a table or a view.

Columns

Select the column or columns on which the index is based and the sorting order.

Included Columns

Select the non-key columns to be added to the leaf level of the nonclustered index.

Note: Support from SQL Server 2005 or later and SQL Azure.

Navicat Win 585

Editing SQL Server Nonclustered Index Filter

To create a filtered index, specify which rows to include in the index.

Note: Support from SQL Server 2008 or later and SQL Azure.

Example:

StartDate > '20040101' AND EndDate <= '20040630'

Navicat Win 586

Editing Advanced SQL Server Nonclustered Index Properties

Ignore duplicate key values

A warning message will occur when duplicate key values are inserted into a unique index.

Only the rows violating the uniqueness constraint will fail.

Recompute statistics

Enable automatic statistics updating.

Allow row locks

Row locks are allowed when accessing the index. The Database Engine determines when row locks are used.

Note: Support from SQL Server 2005 or later.

Allow page locks

Page locks are allowed when accessing the index. The Database Engine determines when page locks are used.

Note: Support from SQL Server 2005 or later.

Create / Rebuild Option

Fill Factor (%)

Specify a percentage that indicates how full the Database Engine should make the leaf level of each index page during index creation or rebuild. Fill Factor must be an integer value from 1 to 100.

Note: SQL Azure does not support.

Pad Index

The percentage of free space that is specified by fillfactor is applied to the intermediate-level pages of the index.

Note: Support from SQL Server 2005 or later.

Sort in tempdb

Specify to store temporary sort results in tempdb.

Note: SQL Azure does not support.

Navicat Win 587

Online

Long-term table locks are not held for the duration of the index operation.

Note: Support from SQL Server 2005 or later and SQL Azure.

Max. degree of parallelism

Override the max degree of parallelism configuration option for the duration of the index operation.

Note: Support from SQL Server 2005 or later.

Navicat Win 588

Editing SQL Server Nonclustered Index Storage

SQL Azure does not support this tab.

On Filegroup

Filegroup

Choose a filegroup.

On Partition Scheme

Note: Support from SQL Server 2005 or later.

Partition Scheme

Choose a partition scheme.

Partition Column

Choose a partition column name.

Data Compression

Note: Support from SQL Server 2008 or later.

Partition Number

The partition which the DATA_COMPRESSION setting applies.

Type

NONE

Index or specified partitions are not compressed.

ROW

Index or specified partitions are compressed by using row compression.

PAGE

Index or specified partitions are compressed by using page compression.

Navicat Win 589

Editing SQL Server Clustered Index Properties

To create a clustered index:



Editing Clustered Index General

Editing Advanced Clustered Index Properties

Editing Clustered Index Storage

Navicat Win 590

Editing SQL Server Clustered Index General

Type

Choose the index type: Nonclustered, Clustered, XML or Spatial

Unique

A unique index is one in which no two rows are permitted to have the same index key value.

Table / View

Choose to create a table index or a view index.

Table name or View Name

Select a table or a view.

Columns

Select the column or columns on which the index is based ans the sorting order.

Navicat Win 591

Editing Advanced SQL Server Clustered Index Properties

Ignore duplicate key values

A warning message will occur when duplicate key values are inserted into a unique index.

Only the rows violating the uniqueness constraint will fail.

Recompute statistics

Enable automatic statistics updating.

Allow row locks

Row locks are allowed when accessing the index. The Database Engine determines when row locks are used.

Note: Support from SQL Server 2005 or later.

Allow page locks

Page locks are allowed when accessing the index. The Database Engine determines when page locks are used.

Note: Support from SQL Server 2005 or later.

Create / Rebuild Option

Fill Factor (%)

Specify a percentage that indicates how full the Database Engine should make the leaf level of each index page during index creation or rebuild. Fill Factor must be an integer value from 1 to 100.

Note: SQL Azure does not support.

Pad Index

The percentage of free space that is specified by fillfactor is applied to the intermediate-level pages of the index.

Note: Support from SQL Server 2005 or later.

Sort in tempdb

Specify to store temporary sort results in tempdb.

Note: SQL Azure does not support.

Navicat Win 592

Online

Long-term table locks are not held for the duration of the index operation.

Note: Support from SQL Server 2005 or later and SQL Azure.

Max. degree of parallelism

Override the max degree of parallelism configuration option for the duration of the index operation.

Note: Support from SQL Server 2005 or later.

Navicat Win 593

Editing SQL Server Clustered Index Storage

SQL Azure does not support this tab.

On Filegroup

Filegroup

Choose a filegroup.

File Stream Filegroup

Choose a filegroup for FILESTREAM data.

Note: Support from SQL Server 2008 or later.

On Partition Scheme

Note: Support from SQL Server 2005 or later.

Partition Scheme

Choose a partition scheme.

Partition Column

Choose a partition column name.

File Stream Partition Scheme

Choose a partition scheme for FILESTREAM data.

Note: Support from SQL Server 2008 or later.

Data Compression

Note: Support from SQL Server 2008 or later.

Partition Number

The partition which the DATA_COMPRESSION setting applies.

Type

NONE

Index or specified partitions are not compressed.

Navicat Win 594

ROW

Index or specified partitions are compressed by using row compression.

PAGE

Index or specified partitions are compressed by using page compression.

Navicat Win 595

Editing SQL Server XML Index Properties

To create a XML index:

Note: Support from SQL Server 2005 or later.



Editing XML Index General

Editing Advanced XML Index Properties

Navicat Win 596

Editing SQL Server XML Index General

Type

Choose the index type: Nonclustered, Clustered, XML or Spatial

Table / View

Must be TABLE.

Table name

Select a table.

XML Column

Select the xml column on which the index is based.

XML Index Type

PRIMARY

A clustered index is created with the clustered key formed from the clustering key of the user table and an XML node identifier.

PATH secondary

Create a secondary XML index on columns built on path values and node values in the primary XML index. In the PATH secondary index, the path and node values are key columns that allow efficient seeks when searching for paths.

VALUE secondary

Create a secondary XML index on columns where key columns are (node value and path) of the primary XML index.

PROPERTY secondary

Create a secondary XML index on columns (PK, path and node value) of the primary XML index where PK is the primary key of the base table.

Primary XML Index

Specify the primary XML index to use in creating a secondary XML index.

Navicat Win 597

Editing Advanced SQL Server XML Index Properties

Recompute statistics

Enable automatic statistics updating.

Allow row locks

Row locks are allowed when accessing the index. The Database Engine determines when row locks are used.

Allow page locks

Page locks are allowed when accessing the index. The Database Engine determines when page locks are used.

Create / Rebuild Option

Fill Factor (%)

Specify a percentage that indicates how full the Database Engine should make the leaf level of each index page during index creation or rebuild. Fill Factor must be an integer value from 1 to 100.

Pad Index

The percentage of free space that is specified by fillfactor is applied to the intermediate-level pages of the index.

Sort in tempdb

Specify to store temporary sort results in tempdb.

Max. degree of parallelism

Override the max degree of parallelism configuration option for the duration of the index operation.

Navicat Win 598

Editing SQL Server Spatial Index Properties

To create a spatial index:

Note: Support from SQL Server 2008 or later and SQL Azure.



Editing Spatial Index General

Editing Advanced Spatial Index Properties

Navicat Win 599

Editing SQL Server Spatial Index General

Type

Choose the index type: Nonclustered, Clustered, XML or Spatial

Table / View

Must be TABLE.

Table name

Select a table.

Tessellation Scheme

The tessellation scheme for the spatial index.

Bounding Box

Specify a numeric four-tuple that defines the four coordinates of the bounding box: the x-min and y-min coordinates of the lower, left corner, and the x-max and y-max coordinates of the upper right corner.

Min. Coordinates

Specify the x-coordinate (X) and y-coordinate (Y) of the lower-left corner of the bounding box.

Max. Coordinates

Specify the x-coordinate (X) and y-coordinate (Y) of the upper-right corner of the bounding box.

Grid Density

Define the density of the grid at each level of a tessellation scheme.

Level 1

Specify the first (top) level grid.

Level 2

Specify the second-level grid.

Level 3

Specify the third-level grid.

Navicat Win 600

Level 4

Specify the fourth-level grid.

Cells Per Object

Specify the number of tessellation cells per object that can be used for a single spatial object in the index by the tessellation process.

Navicat Win 601

Editing Advanced SQL Server Spatial Index Properties

Recompute statistics

Enable automatic statistics updating.

Allow row locks

Row locks are allowed when accessing the index. The Database Engine determines when row locks are used.

Note: SQL Azure does not support.

Allow page locks

Page locks are allowed when accessing the index. The Database Engine determines when page locks are used.

Note: SQL Azure does not support.

Create / Rebuild Option

Note: SQL Azure does not support.

Fill Factor (%)

Specify a percentage that indicates how full the Database Engine should make the leaf level of each index page during index creation or rebuild. Fill Factor must be an integer value from 1 to 100.

Pad Index

The percentage of free space that is specified by fillfactor is applied to the intermediate-level pages of the index.

Sort in tempdb

Specify to store temporary sort results in tempdb.

Max. degree of parallelism

Override the max degree of parallelism configuration option for the duration of the index operation.

Navicat Win 602

SQL Server Synonyms

A synonym is an alternative name for a schema-scoped object. Client applications can use a single-part name to reference a base object by using a synonym instead of using a two-part, three-part, or four-part name to reference the base object.

Create Synonym

To create a new synonym



Select anywhere on the object pane.

Click the New Synonym from the object pane toolbar. or

Right-click and select New Synonym from the popup menu.

Edit synonym properties on the appropriate tabs of the Synonym Designer.

To create a new synonym with modification as one of the existing synonym



Select the synonym for modifying in the object pane.

Right-click and select the Design Synonym from the popup menu or simply double-click the synonym. or

Click the Design Synonym from the object pane toolbar.

Modify synonym properties on the appropriate tabs of the Synonym Designer.

Click Save As.

Edit Synonym

To edit the existing synonym(manage its general etc)



Select the synonym for editing in the object pane.

Right-click and select the Design Synonym from the popup menu or simply double-click the synonym. or

Click the Design Synonym from the object pane toolbar.

Edit synonym properties on the appropriate tabs of the Synonym Designer.

Navicat Win 603

To change the name of the synonym



Select the synonym for editing in the object pane.

Right-click and select the Rename from the popup menu.

Delete Synonym

To delete a synonym



Select the synonym for deleting in the object pane.

Right-click and select the Delete Synonym from the popup menu. or

Click the Delete Synonym from the object pane toolbar.

Confirm deleting in the dialog window.

Achieve Synonym Information

To achieve a synonym information



Select the synonym in the object pane.

Right-click the selected synonym and choose Object Information from the popup menu. or

Choose View -> Object Information in the main menu.

Navicat Win 604

SQL Server Synonym Designer

Synonym Designer is the basic Navicat tool for working with synonym. It allows you to create new synonym and edit the existing synonym properties.



Editing Synonym General

Editing Synonym Comment (SQL Azure does not support)

Synonym SQL Preview

Navicat Win 605

Editing SQL Server Synonym General

Object Linked Server

The name of the server on which base object is located.

Note: SQL Azure does not support.

Object Database

The name of the database in which the base object is located.

Object Schema

The name of the schema of the base object.

Object Type

The object type.

Object

The name of the base object that the synonym references.

Navicat Win 606

SQL Server Triggers

A trigger is a special kind of stored procedure that automatically executes when an event occurs in the database server.