Plyxon Users Guide
Plyxon Users Guide
0
User’s Guide
October 2023
Plyxon 1.0 User’s Guide 3
Contents
1 Introduction......................................................................................................... 6
2 Installation .......................................................................................................... 7
5 SQL Documents.................................................................................................. 21
14 Preferences ..................................................................................................... 57
14.6 Directories................................................................................................ 62
1 Introduction
Plyxon is a lightweight, easy-to-use, high-performance Oracle PL/SQL Development
tool for Windows, macOS and Linux.
All screenshots in this User’s Guide are from the Microsoft Windows version. The
screens of the macOS and Linux versions are all equivalent. Where function key
examples with the Ctrl key are used, you should use the Command key instead on
MacOS.
Plyxon 1.0 User’s Guide 7
2 Installation
2.1 System Requirements
PL/SQL Developer requires an Oracle Client installation for communication with your
Oracle Servers. The following installation chapters describe the installation process
of the Oracle Client, and the installation process of Plyxon for all supported
platforms.
64-bit: https://www.allroundautomations.com/icwindows64.html
32-bit: https://www.allroundautomations.com/icwindows32.html
Installing Plyxon
Double-click on the downloaded setup file (plyxon<version>.msi) to start the
installation process and follow the instructions.
https://www.allroundautomations.com/icmacos64.html
Plyxon 1.0 User’s Guide 8
Installing Plyxon
Double-click on the downloaded Disk Image file (plyxon<version>.dmg), start the
installer within the image, and follow the instructions.
https://www.allroundautomations.com/iclinux64.html
Installing Plyxon
There are 4 different installation packages available:
• DEB package: Right-click on the plyxon<version>.deb file and use the Software
Install utility for installation.
• RPM package: Right-click on the plyxon<version>.rpm file and use the Software
Install utility for installation.
• RUN installer: Extract the plyxon<version>.run.tar.gz file and start the
plyxon<version>.run file for installation.
• TAR archive: Extract the plyxon<version>.tar.gz file and start plyxon from the
extracted directory.
Plyxon 1.0 User’s Guide 9
On the first page you can follow the Oracle Client download link if you do not yet have
an Oracle Client installed on your system (see chapter 2). If you have installed an
Oracle Client, click on the Next button to continue to the next page of the Wizard.
Plyxon 1.0 User’s Guide 10
You can select a Full Oracle Client here, or you can select Oracle Instant Client if
such a client is installed on your system.
Plyxon 1.0 User’s Guide 11
Platform Filename
Microsoft Windows oci.dll
macOS libclntsh.dylib
Linux libclntsh.so
You can select an Oracle Client Library from the list or click on the Select other
button to select the library from another directory on the file system.
Plyxon 1.0 User’s Guide 12
The tnsnames.ora file defines the names and network locations of the Databases that
can be accessed from the Oracle Client. If you select a directory from the list, the
available Databases will be displayed in the bottom section.
If the network configuration directory is not listed, you can click on the Select other
button to select a tnsnames.ora file from another directory on the file system.
Plyxon 1.0 User’s Guide 13
The Language and Character Set will be applied to the NLS_LANG of the client. The
Date Format will be applied to the NLS_DATE_FORMAT of the client. The Number
Format will be applied to the NLS_NUMERIC_CHARACTERS of the client. The Time
Format will be used when displaying or setting time fractions of Oracle date
information.
On this final page you can either click on Finish to apply these settings and start
Plyxon, or you can press Test Connections to test if Databases are accessible with
these settings.
Plyxon 1.0 User’s Guide 14
For each Database you can see whether it is accessible, and what the connection
performance is. If a Database is not accessible, the error message will be displayed.
Plyxon 1.0 User’s Guide 15
On the right side you can enter the Username, Password, Database, and role of your
account. Click on the Connect button to make the connection.
On the left side you see a list of recently used accounts and user-defined accounts.
This list will initially be empty.
Plyxon 1.0 User’s Guide 16
You can run these example documents to get a basic idea of Plyxon concepts. You can
run them in sequence from left to right. The first documents will create some example
objects. All object names start with the plyxon_ prefix so that they do not clash with
any objects that you may already have created under the current account. The last
document will drop all example objects so that everything is cleaned up again.
Run the first 3 examples to create the tables and packages that are used in the
examples in this document.
Plyxon 1.0 User’s Guide 17
Right-click on the tool tab to move the tool to the left or right, or to hide it. To make a
tool visible again, select it from the View button ( ) in the application button area.
Plyxon 1.0 User’s Guide 18
Click on the Dock button ( ) to place the window contents back into the document
area again.
Plyxon 1.0 User’s Guide 19
If you have many documents opened, you can click on the Document List button ( )
above the Document Area to get a list of all currently opened documents:
Here you can go to a specific document by clicking on the item in the list, or close a
document by clicking on the Close Document button ( ) in the list.
Here you can select a recently used account from the Recent folder, select a user-
defined account, or explicitly enter the account information. Press the Connect button
to connect the Plyxon IDE to the Database with this account.
The Plyxon IDE can only connect with one account at a time, so all documents will
use the same account.
Plyxon 1.0 User’s Guide 20
Each document has its own separate Database session, and therefore also its own
separate Database transaction. Uncommitted changes in one document (typically
from SQL insert, update, and delete commands) will therefore not be visible in
another document.
If you click on the list arrow ( ) next to the Account button, you will find additional
functions to logoff, to change the password of the current account, or to logon with a
recently used account.
Plyxon 1.0 User’s Guide 21
5 SQL Documents
SQL Documents contain one or more SQL Commands, separated by a terminator.
When executing a SQL Document, individual commands will be sent to the Oracle
Database and the results will be displayed.
A SQL Document can be stored on the file system or in the Oracle Database Dictionary
if it is the source of a Database object like a function, procedure, package, type,
trigger, or view.
The results of the SQL Command will be displayed in the bottom pane of the SQL
Document. If an error occurs during execution, the corresponding line will be
highlighted, and the text cursor will be placed at the exact error location.
The status line at the bottom of the SQL Document indicates the change status ( )
and execution status ( ) of the document.
On the right side of the status line there is a button to hide ( ) or show ( ) the result
pane. You can also press Ctrl-R.
Plyxon 1.0 User’s Guide 22
The bottom pane will now show the results of the SQL Command at the text cursor
position. The status line will show the number of SQL Commands executed, as well as
the number of errors and warnings, and the overall time. Move the text cursor to
another SQL Command to view its results.
If your SQL Document is very long, you can quickly navigate to a specific SQL
Command by selecting it from the list at the top of the SQL Document. By default, the
Plyxon 1.0 User’s Guide 23
list will show the first lines of each SQL Command, but you can precede it with a
Name=<Description> comment to specify a specific name for the list:
Click on the Execute Current Command button ( ) if you want to execute the SQL
Command at the text cursor. Click on the list arrow ( ) next to the button for
additional options:
5.4 DBMS_Output
If your SQL Commands generate DBMS_Output through the dbms_output.put or
dbms_outp.put_line procedures, the result pane will show the output after execution:
DBMS_Output buffering will be enabled by default with an unlimited buffer size. You
can change this in the SQL Document by calling the dbms_output.disable and
dbms_output.enable procedures.
5.5 Variables
You can use variables in a SQL Command to ask for input before execution and/or
show output after execution. There are 2 types of variables:
• Substitution Variables, which are preceded by an ampersand (&) in the SQL Code.
These variables can only be used for input. All occurrences of these variables in
Plyxon 1.0 User’s Guide 24
the SQL Code will be replaced by their values before sending it to the Database
Server.
• Bind Variables, which are preceded by a colon (:) in the SQL Code. These variables
can be used for input and output. The SQL Code will not be modified, and the
values will be attached to the SQL Code when sending it to the Database Server.
Bind variables are typically used for SQL parameterization in programming
languages like C++ and Java.
Bind Variables can only be used where you can normally use variables in PL/SQL.
You can use them for values, but not for things like column names, table names,
and so on.
Using Variables
The following SQL Command uses a Bind Variable Department to restrict the result
set, and a Substitution Variable Sort Column to specify the sort order of the result set:
When executed, you will first be prompted for these variable values of Bind Variable
Department and Substitution Variable Sort Column in the variable value input form:
By default, Bind Variables have a string data type, and Substitution Variables are
untyped. You can define the data type and many other variable properties by clicking
on the Define button. Variable Definitions are described in detail in the next chapter.
Plyxon 1.0 User’s Guide 25
After execution there will be a Result set tab and an additional Variables tab where
the variable values can be viewed:
If any of the variables have a different output value, both the input value and output
value will be displayed. For example:
When executed you would be prompted for the value of Substitution Variable &D. To
prevent this, specify && instead:
Now R&&D will be replaced by R&D before the command is sent to the Oracle Server.
Plyxon 1.0 User’s Guide 26
Defining Variables
You can define the data type and many other properties of variables by clicking on the
Define Variables button ( ) on the toolbar, which will bring up the Variable
Definitions form:
On the left you can select one of the variables that are used in the current SQL
Command. In the screenshot above you see the Department and Sort Column
variables of the first example of the previous chapter. On the right you can view and
set the properties of the selected variable.
After defining variable properties and pressing OK, a comment block will be added to
the SQL Command:
This comment block controls how the variables are processed during data entry, and
how the values are passed to the Oracle Server during execution. You can change
these properties later by clicking on the Define Variables button again, by clicking on
Plyxon 1.0 User’s Guide 27
the Define button in the variable value input form, or by changing comment block
directly in the text.
Since the variable properties are maintained in a comment block that is only
interpreted by Plyxon, this information will be ignored when executing the SQL in
another tool.
General Properties
The following properties are available on the General tab page:
Type
Specifies the data type of the variable.
For Bind Variables the data will be passed to the Oracle Server with the corresponding
type. The default type is string.
Required
Indicates whether a value is required for the variable.
Default
The default value will be displayed in the variable value input form when the SQL
Command is executed for the first time. If the SQL Command is executed again later
during the session, a previously entered value will be displayed.
The default value can be a literal value, or a select statement that returns exactly 1
column and 1 row such as "select username from dual".
If Empty
The value that will be used if no value is supplied. Just like the default value, this can
be a literal value or a select statement.
Prompt
The prompt displayed for the variable on the value entry form. If you omit this
property, the variable name will be displayed.
Plyxon 1.0 User’s Guide 28
This is primarily useful for Bind Variables, for which you cannot use quotes in the
name. For example, &"Dept Number" is a valid Substitution Variable name, but :"Dept
Number" is not a valid Bind Variable name. In this case you can specify :DeptNo in
the SQL text and specify Dept Number for the prompt property.
Hint
The hint will be displayed in the value entry form when the focus is on this variable.
This can be used to display a longer description for the variable.
Prefix / Suffix
The prefix and suffix will be implicitly added to the value if a value is supplied. For
example, if a variable represents an optional parameter value, the prefix could be "("
and the suffix could be ")". If you supply a value, it will be enclosed in parentheses. If
you omit the value, the parentheses will be omitted as well.
Uppercase / Lowercase
When enabled, the value will be converted to uppercase or lowercase.
MultiLine
When enabled, the edit control will display the text <Multiple Lines> and a button will
be available to view and edit the text with multiple lines.
Plyxon 1.0 User’s Guide 29
Items
The items of the list can be specified as comma-separated values, or as a select
statement. In the example above the list will be populated with all departments from
the plyxon_dept table.
With Description
Indicates if the list items include both the value and description. The description will
be presented in the list, and the value will be used for the variable.
In the example above the select statement first includes the value field (deptno) and
secondly the description field (dname).
If comma-separated items are supplied for the list, the first item is a value, the
second item is its description, and so on. For example:
Restricted
Indicates if the list is restricted to the items, or if you can also type other values in
the list control.
Plyxon 1.0 User’s Guide 30
MultiSelect
When enabled you can select multiple items from the list. The resulting value will be
a comma-separated string with all selected items. This is primarily useful when using
a Substitution Variable for an IN condition. For example:
In this case the Department List variable will be replaced by a comma-separated list
of selected items. Note that you cannot use a Bind Variable for IN conditions.
Hidden properties
When selecting a hidden control type, the variable will be hidden on the variable
value input form. A hidden control has no properties. This is useful for output-only
variables. The variable value will still be visible in the result pane of a SQL Document
after execution.
Plyxon 1.0 User’s Guide 31
After you have entered the variables and pressed the OK button, a SQL Document
appears with a template function in it. Each Program Unit you create in the SQL
Document must start with the familiar create or replace SQL syntax and must be
terminated with a line with just a slash (/). In this case we are creating a function
Even, and the source file could look like this:
Click on the Execute button ( ) or press F8 to compile the Program Unit into the
Database. If there are any compilation errors or warnings, they will be highlighted in
the editor, and displayed in a list below the editor. Double-click on an error or warning
to navigate to the location in the editor.
Plyxon 1.0 User’s Guide 32
There is no need to perform any additional Save operations if you prefer to work only
with Program Unit sources stored in the Oracle Database.
If you prefer to work with source files on the file system instead, you can save the
SQL Document to a file by clicking on the Save button ( ) or the Save As button ( )
on the SQL Document toolbar.
When working with source files on the file system, you can open the SQL Document
file by clicking on the Open button ( ) in the application button area, or by double-
clicking on the file in the File List (see chapter 11).
If the Program Unit is not yet compiled or saved, the Compare to items will be
disabled.
See chapter 9.6 for more information about the Difference Viewer.
Plyxon 1.0 User’s Guide 33
Variables are declared for each parameter and for the function result. Variables for
output-only parameters and the function result will be declared as hidden, so that
they will not be displayed on the variable value input form. They will be displayed on
the variable tab of the result pane after execution. Executing this test will first ask for
the input parameter values:
Plyxon 1.0 User’s Guide 34
After clicking on the View Stack button, the Error Stack will be displayed:
On the left you see the Call Stack, where you can click on a stack line to view the
corresponding source to the right.
Plyxon 1.0 User’s Guide 35
On the right you see the current source with the current source line highlighted.
On the bottom left you see the local variables and their values. For packages you will
additionally see the global private variables and global public variables. For object
types you will additionally see the attribute values. Note that you can also view
variable values by holding the mouse cursor over a variable name in the source.
On the upper left you see the current Call Stack. Clicking on a stack line will display
the corresponding source and will update the variables.
Controlling Execution
To control execution, you can use the following buttons from the Debugger toolbar:
Run to completion.
Cancel execution.
Step to the next line.
Step into a call.
Step out of a call.
Run to the cursor position.
Run to the next exception.
Plyxon 1.0 User’s Guide 36
Breakpoints
You can set a breakpoint on a source line so that execution will be halted when
program execution reaches this line. To set or clear a breakpoint, simply click in the
left margin of the editor at the source line location:
You can do this both in the SQL Document and in the Debugger.
Plyxon 1.0 User’s Guide 37
Click on the Apply button ( ) of the Result Set toolbar or press F10 to apply these
changes to the Oracle Database as one transaction. The transaction will
automatically be committed.
In case of an error, the transaction will be rolled back. You can now make corrections
in the Result Set and try to apply the changes again.
To undo all changes in the Result Set, click on the Undo button ( ) of the Result Set
toolbar or press Shift-F10.
To refresh the Result Set from the Oracle Database, click on the Refresh button ( )
of the Result Set toolbar or press F5. Any unapplied changes will be lost.
Plyxon 1.0 User’s Guide 38
If the text data consists of multiple lines, it will be displayed as <Multiple Lines>. If
the text data type is a CLOB or LONG, it will be displayed as <CLOB> or <LONG>.
To view or edit the complete text data, click on the cell and subsequently on the cell
button. You can also double-click on the cell. This will show a Text Editor with the cell
contents:
On the toolbar of the Text Editor, you can load the contents from a text file, save the
contents to a text file, print the contents, and perform various text editor functions.
Plyxon 1.0 User’s Guide 39
On the toolbar of the Large Data Editor, you can load the contents from a file, save the
contents to a file, copy the contents to the clipboard, paste the contents from the
clipboard, clear the contents, or print it.
Note that the Large Data Editor can only display images, and PDF content. For all
other data types, it will only display the size of the contents.
To mark multiple cells of a Result Set, you can first click on the start cell, and
subsequently click on the end cell to mark all the cells in between. For example:
In the top section you can select the file format, and in the bottom section you can
select the output file and, depending on the selected format, the following options:
• Add a BOM for Unicode Results: The output file will have a UTF-8 BOM (Byte
Order Mark) header if the Result Set is from a Unicode Database. Some
applications require this BOM to properly identify Unicode text.
• Open File when Finished: The output file will be opened in a viewer or editor as
configured in your Operating System.
Plyxon 1.0 User’s Guide 41
• Copy Results to Clipboard: The contents of the output file will be copied to the
clipboard in text format.
Plyxon 1.0 User’s Guide 42
The Edit submenu ( ) contains functions for editing and selecting text.
The Find submenu ( ) contains functions for finding and replacing text.
Press Enter or click the Find Next button to start the search. All occurrences in the
SQL Editor will now be highlighted. If you have also entered a replacement text, you
can click on the Replace button to replace the currently selected text, or click on the
Replace All button to replace all occurrences.
When using regular expressions, you can click on the Regular Expression Functions
buttons ( ) to select a function. The selected function will then be inserted into the
find or replacement text at the cursor position.
If a selection is marked in the SQL Editor, you can use the Range option to limit the
search to that selection.
You can use the Search In options to limit the search to comments, strings, and other
parts of the SQL Editor text.
Plyxon 1.0 User’s Guide 43
9.2 Macros
To record a Macro, select the Record Macro item from the Edit submenu or press Ctrl-
Alt-R. All keystrokes that you subsequently type will be recorded, until you select
Stop Macro from the Edit submenu or press Ctrl-Alt-X. You can now select Play Macro
from the submenu or press Ctrl-Alt-X to play the Macro again.
Note that only keystrokes are recorded. Mouse movement and mouse clicks are not
recorded. Therefore, you need to make sure that you perform all editor actions from
the keyboard when you record a Macro.
You can additionally perform a maximum of one Find operation for a Macro through
Ctrl-F.
Macro Library
You can use the Macro Library to save Macros for later reuse. After recording a Macro,
you can add it to the Macro Library by selecting Macro Library from the Edit submenu.
For example:
The Description will be displayed in the list. If you enable the Menu option, the Macro
will also be added to a submenu under the Macro Library menu item for immediate
playback. You can additionally define a Shortcut Key to play the Macro. You need to
ensure that this key does not conflict with other keys defined in the preferences (see
chapter 14).
If your Macro includes a Find operation, the search text, replacement text, and other
search options are included here as well.
To modify the search criteria, you can click on the Search Criteria button ( ). You can
now use the Find Dialog to define these criteria.
Plyxon 1.0 User’s Guide 44
Code Completion
The Code Completion function assists you by completing partially typed symbols. It
will display a selection list of matching names from which you can choose. In addition
to global and local object names, it will also include PL/SQL syntax elements and
Code Snippet names (see chapter 9.5). For example:
After typing the d alias and the dot, the Code Assistant will display a list of columns of
table plyxon_dept. If you continue to type, the list will be filtered for all elements
that contain the partial name that you typed. If the list is reduced to 1 item, you can
press Enter or Tab to insert it into the SQL Editor. You can also press Down to
explicitly select a specific item, followed by Enter or Tab to insert it, or double-click
on the item.
For some lists, such as parameter lists, an (All) item will be added at the top. This way
you can quickly add all items. You can also Ctrl-click or Shift-click with the mouse to
select multiple items in this case.
You can sort the items alphabetically by clicking on the Sort button ( ). Clicking on
the Sort button again will restore the original sort order from the object definition.
For parameter lists of overloaded functions and procedures, you will additionally have
a Previous Overloading button ( ) and a Next Overloading button ( ) to display the
corresponding parameter list.
Plyxon 1.0 User’s Guide 45
In the preferences you can change various Code Assistant options (cee chapter 14.4).
Code Insight
You can view the declaration of a symbol by holding the mouse cursor over the symbol
in the SQL Editor. Its declaration will subsequently be displayed in a popup. For
example:
Holding the mouse over the dbms_alert.register procedure will display all relevant
parameter information.
The standard Code Snippets also includes a Program Units subdirectory, which
contains Code Snippets that are available from the Program Units list of the New
button ( ). When creating a new function from this button list, the Function.sql Code
Snippet from the Program Units subdirectory will be invoked.
1. Drag & Drop the Code Snippet from the File List into the SQL Editor.
2. Type the (partial) name of the Code Snippet in the SQL Editor and select it from
the Code Completion list of the Code Assistant (see chapter 9.3).
If the Code Snippet contains any Substitution Variables, you will be prompted for the
values. The substituted code will then be inserted into the SQL Editor.
Example
Assume you frequently need to program a procedure call diagnostics.log_error with a
Severity and a Message parameter. You can create a Code Snippet with the following
text:
Plyxon 1.0 User’s Guide 47
Save the Code Snippet in a directory and with a filename that is easy to find. In this
case it is saved in subdirectory Diagnostics and with filename Log_Error.sql.
To invoke the Code Snippet, you can type the partial directory name or file name, and
select the corresponding item from the Code Assistant:
When this Code Snippet is invoked, it will prompt for the value of the Severity and
Message parameters. For the Severity parameter you can select Critical, Major, or
Minor, which will be translated to a corresponding code.
begin
diagnostics.log_error(2, 'Testing the Code Snippet');
end;
The Difference Viewer will display the changed version in the SQL Editor on the left,
and the original version on the right, and will mark all differences. For example:
Added lines are marked green, deleted lines are marked red, and changed lines are
marked blue with all different characters marked with a red underlining. Completely
to the right you see an overview of all changes in the SQL Document, with the
viewport frame that you can drag to scroll. On the status line you can see a summary
of all changes.
The toolbar buttons provide functions to navigate to the next change ( ) and previous
change ( ), to switch between a horizontal view ( ) and vertical view ( ), to swap
the contents ( ), and to change the options ( ). From the options button list you can
select the following:
• Ignore Case: Differences in case will be ignored, except for differences in string
constants.
• Ignore White Space: Differences in white space characters (spaces, tabs, and
linefeeds) will be ignored, except for differences in string constants.
• Ignore Comments: Differences in comments will be ignored. Note that differences
in white space will also implicitly be ignored.
• Show Inline Differences: When enabled, different characters on a changed line
will be marked with a red underlining.
Plyxon 1.0 User’s Guide 49
You can enter a filter text so that only statements are listed that include this text.
If you right-click on the list, you get a popup menu with the following options:
You can switch between statements from All Accounts or only the Current Account.
You can additionally copy the selected statement to the clipboard, delete it, or view
the complete text in a text editor.
By default, the list will display each statement on one line. You can use the Expand
All and Collapse All menu items to view multiple lines or one line.
Plyxon 1.0 User’s Guide 50
Limitations
• The recall buffer is limited to 200 statements. When this limit is reached, the
oldest statements are deleted from the buffer.
• The maximum statement size in the buffer is 4000 bytes. Statements that are
longer will not be added to the buffer.
• PL/SQL compilation statements (create or replace function / procedure /
package / type / trigger) are not added to the recall buffer. Anonymous PL/SQL
Blocks (begin ... end;) will be added.
• When executing SQL Documents with more than 1 statement, these statements
will not be added to the recall buffer. Only statements that are individually
executed will be added.
Plyxon 1.0 User’s Guide 51
10 Object List
The Object List allows you to quickly access Database objects of a user:
At the top of the Object List, you can select the user for which you want to access the
objects. You can additionally enter a filter text and press Enter so that only objects
are listed that have a name that includes the filter text.
11 File List
The File List allows you to quickly access files from user-defined File Locations:
By default, you will see your Documents location, the Shared Documents location, the
Examples location, and the Code Snippets location (see chapter 9.5). You can add
your own locations as needed (see chapter 11.1).
At the top of the File List, you can enter a filter text and press Enter so that only files
are listed that have a name that includes the filter text.
On the left you see a list of File Locations where they can be added, deleted, or
moved. On the right you can change the properties of the selected File Location:
12 Account List
The Account List allows you to quickly connect with recently used or user-defined
Accounts:
The Recent folder shows the Accounts that you have most recently used. Other
folders show the user-defined Accounts.
On the left you see a list of Accounts and folders where they can be added, deleted, or
moved. On the Definition page you can change the properties of the selected Account
or folder:
• Display section: The Description will be displayed in the Account List. If you omit
the description, the Account will be displayed as username@database. The Color
defines the icon color in the Account List.
• Authentication section: The Username, Password, Database, and role information
of the Account. Enable the Identified Externally option to indicate that you can
connect with the Account without specifying a password. When defining a folder
instead of an Account, this section is not available.
You can use the Test button to check if the authentication information is correct.
On the Initialization page you can define a SQL script that will be executed for each
Database session that is created for the Account. Terminate SQL statements with a
semicolon, and PL/SQL Blocks with a slash.
On the Message page you can define a message that will be presented when you
connect with the Account.
Plyxon 1.0 User’s Guide 56
Here you can define the table columns, constraints, and indexes. Click on the Add
button ( ) to the right of the list to create a new column, constraint, or index. Click
on the Delete button ( ) to delete it.
After defining or editing the table, click on the Apply button ( ) or press F10 to apply
it to the Database. Before clicking on the Apply button, you can click on the View
Changes button ( ) to preview or save the changes in a SQL Document. After clicking
Apply you can go to the Log tab page to review or save the changes in SQL format. The
Log tab page will include all changes, even if they are applied separately.
When editing an existing table, click on the Cancel button ( ) or press Shift-F10 to
cancel any changes you have made, or click on Refresh button ( ) or press F5 to
refresh the table definition from the Database.
Plyxon 1.0 User’s Guide 57
14 Preferences
You can change many preferences to control the behavior and appearance of Plyxon.
Click on the Configure button ( ) in the application button area to open the
Preferences form with tab pages for different categories of preferences:
To reset preferences to their original value, click on the Reset button ( ). The button
list allows you to reset the currently selected preference, the current preference
page, or all preferences.
Plyxon 1.0 User’s Guide 58
14.1 Oracle
On the Oracle page you can configure your Oracle Client and other Oracle-related
preferences.
The Oracle Home list is only available on Microsoft Windows, and only if there are one
or more full Oracle Client installations on the system. You can select an Oracle Home
and click on the Copy button to copy the settings from the Oracle Home to the
preferences below.
If the Oracle Home list is not available, you can click on the Oracle Client Wizard
button (see chapter 3.1) to configure the Oracle Client preferences.
The Environment Variables grid allows you to define additional Oracle environment
variables. In the example above, NLS_LENTGH_SEMANTICS is set to CHAR.
The Logoff with Open Transaction defines the behavior when you close a document
when there is still an open Database transaction. You can choose to automatically
commit or rollback, or to ask for confirmation.
Plyxon 1.0 User’s Guide 59
If the Add Debug Information when Compiling option is enabled, each compilation
will implicitly add debug information so that you can step through the code when
using the debugger (see chapter 7.3). When disabled, you need to right-click on a
program unit in the Object List (see chapter 10) and select Add Debug Information to
allow debugging.
14.2 General
• Color Theme Mode: Allows you to select a Light or Dark mode for Plyxon. When
selecting Auto, the system preference will be used.
• Maximum Recent Files: The maximum number of files in recent file lists.
• Autosave Desktop: When enabled, previously opened files and Database objects
will be reopened when restarting Plyxon.
• Ask to Save New Database Sources to a File: Disable this preference if you keep
all your Program Unit sources in the Database, and not in files. In this case, Plyxon
will not ask to save a newly created SQL Document if it contains a Program Unit
that was already compiled, and therefore up to date in the Database.
Plyxon 1.0 User’s Guide 60
14.3 Editor
• Font properties: You can define the font name and size of the editor, as well as the
style (normal, bold, italic), text color, and background color for syntax highlighting
and line highlighting.
• Auto Indent: Pressing Enter will automatically indent the next line to the same
position as the current line.
• Cursor Beyond End of Line: When placing the cursor beyond the end of the line
and typing text, spaces will automatically be inserted to extend the line. If this
preference is disabled, the cursor will be limited to the end of the line.
• Right Margin: Displays a margin line at the given character position. If the value is
0, no right margin is displayed.
• Tab Size: The size of a tab. Spaces will be inserted for tab alignment.
• Smart Tabs: When pressing the Tab key, the editor will try to determine a tab
position from the previous line.
• Trim Trailing Spaces: Trailing spaces will automatically be removed from the text.
• Current Line Indicator: Shows an indicator in the left margin of the current line.
Plyxon 1.0 User’s Guide 61
• Activation Delay: The delay in millseconds before the Code Assistant is activated.
This applies both to typing (for Code Completion) and mouse movement (for Code
Insight). See also chapter 9.3.
• Minimum Typed Characters Before Showing Context Items: When typing a partial
name, the Code Assistant will display context items that match the partial name.
This preference controls the minimum partial name length.
• Align Values when Selecting Multiple Parameters: Parameter values will be
horizontally aligned at => when placed on multiple lines.
• Maximum Items on One Line when Selecting Multiple Items: By default, up to 2
items will be placed on one line, and 3 items or more will be placed on multiple
lines.
• Place Comma Before Item when Inserting Items on Multiple Lines: By default,
the comma will be placed after the item, on the same line. When enabled, the
comma will be placed on the next line before the next item.
Plyxon 1.0 User’s Guide 62
You can define function keys for most Plyxon functions. To assign a key combination
to a function, click on the function to select it and press the key combination. To
remove a key combination from a function, click on the function to select it and press
Esc.
Note that the key combinations for the Set Bookmark and Go to Bookmark functions
are implicitly followed by a 0 to 9 number key.
14.6 Directories
You can define multiple directories for your Code Snippets (see chapter 9.5). The Code
Completion list of the Code Assistant (see chapter 9.3) will include the Code Snippets
from all directories.
Plyxon 1.0 User’s Guide 63
15 Crash Recovery
If you restart Plyxon after a system crash or application crash, the Recover form is
displayed:
At the top you see a list of all Plyxon instances that were terminated as the result of a
crash. At the bottom you see a list of all SQL Documents that were opened for the
selected Plyxon instance. SQL Documents that had unsaved changes at the time of
the crash are marked in red.
To recover SQL Documents, click on the Recover button. All selected SQL Documents
will now be restored.
To remove the recovery information, click on the Remove button. All unsaved changes
will now be permanently lost.
To skip the recovery process, click on the Skip for now button. The Recover form will
be displayed again the next time you start Plyxon.
Recovery files are stored in the recover subdirectory in the plyxon subdirectory in your
document directory.
Plyxon 1.0 User’s Guide 64
16 Command-Line Parameters
When starting Plyxon from the command-line, you can use several parameters.
Parameter names are case insensitive. Parameter values must be placed between
double quotes when they contain special characters like spaces.
userid
Plyxon will connect with the specified user id. The syntax is:
For example:
plyxon userid="scott/tiger@chicago"
theme
Use the light or dark color theme mode. For example:
plyxon theme="dark"
portable
You can use portable mode when placing Plyxon on a portable storage device such as
a USB drive. All configuration files are stored under the Plyxon installation directory,
so that they are preserved when moving from one system to another. You can place
the Oracle Instant Client under the Plyxon directory as well for maximum portability.
For example:
plyxon portable
client_library
Overrides the Oracle Client Library from the preferences. This can be useful when
using different configurations for multiple projects or sites. For example:
plyxon client_library="c:\oracle\dev\bin\oci.dll"
tns_admin
Overrides the Oracle Network Configuration Directory from the preferences. This can
be useful when using different configurations for multiple projects or sites. For
example:
plyxon tns_admin="c:\oracle\dev\network"
Plyxon 1.0 User’s Guide 65
Note that if you save the converted SQL File again, the variable properties will be
ignored in PL/SQL Developer because they are now declared in a comment block that
will only be interpreted by Plyxon.
Program Files
Program Files created in PL/SQL Developer are fully compatible with Plyxon and vice
versa.
Test Scripts
If you open a PL/SQL Developer Test Script (.tst) in Plyxon, it will be converted to a
SQL Document with Bind Variables. If you save the converted SQL Document in
Plyxon, it cannot directly be used in PL/SQL Developer again, because it will ignore all
Bind Variable declarations.
Command Files
Plyxon only supports SQL and PL/SQL commands. Therefore PL/SQL Developer
Command Files can only be used in Plyxon if they do not include SQL*Plus commands
(rem, prompt, print, and so on) and other proprietary commands.
Plyxon 1.0 User’s Guide 66
Templates
PL/SQL Developer Templates will be implicitly converted when used as a Code
Snippet in Plyxon.
SQL Files
SQL Files created in Plyxon can be opened and executed in PL/SQL Developer. If the
SQL File includes Substitution Variables using Plyxon comment format (see chapter
5.5), these variable properties will be ignored. If the SQL File includes Bind Variables,
it cannot be used in the PL/SQL Developer SQL Window. You would need to convert it
to a Test Script or Command Script.
Code Snippets
Code Snippets from Plyxon can only be used in PL/SQL Developer if they do not use
the Plyxon Substitution Variable format.
Connection Definitions
The Plyxon Account List Configuration (see chapter 12.1) allows you to import the
PL/SQL Developer Connection Definitions.