Purpose. Specifies a database name on the server. This name must be unique on the network. The server listens on the network for client requests to access this database and when a client attempts to connect to the database, the server helps establish the connection.
Make sure that for each dbname entry, there exists a corresponding database. Otherwise, the network does not recognize the database.
The following SQL commands and SQL/API functions update the dbname setting:
Default value. The value of this keyword defaults to demo. Example. To identify the test database, specify:
dbname=test
Remember that there must be a test.dbs file in the TEST subdirectory of the home database directory or in the path defined by the database home directory dbdir. You can optionally specify one or more communication library names after the database name. For example, SQLBase Server for Windows NT supports NetBIOS, Anonymous Pipes, SPX (Microsoft Client for NetWare), and SPX (Novell NetWare Client). The following configuration entry directs the server to listen on the network for connection requests to the database using all of those communication libraries:
dbname=test,sqlntnbi,sqlapipe,sqlws32,sqlwsspx
Conversely, the following configuration entry directs the server to listen on the network using only the NetBIOS communication library:
dbname=test,sqlntnbi
Only those client requests to access the test database that are sent via NetBIOS will be successful.
SQL Command SQL/API Function
CREATE DATABASE sqlcre
DROP DATABASE sqldel
INSTALL DATABASE sqlind
Configuration keywords
Remember that any communication libraries that you specify for the dbname configuration entry, must also be specified for the comdll configuration entry. Recommended. Configuration of this keyword is recommended.
Where configured. Configure this keyword in any multi-user server section of the configuration file (sql.ini).
dbwin
Purpose. Determines the status of the Databases subwindow.
The syntax for this window keywords is identical to that for the mainwin keyword, with the addition of a closed status. This indicates that the given subwindow was closed when you last used the Save option of the File menu.
The format of this keyword is:
dbwin=status,x,y,cx,cy
Optional. Configuration of this keyword is optional.
Where configured. This keyword is configured automatically in the server’s GUI section (for example, [dbntsrv.gui]) when you use the Save Settings option in the server’s File menu. Do not set a value for this keyword manually.
defaultdatabase
Purpose. Specifies the default database name, overriding the default of DEMO. Default value. This keyword has no default value.
Example. To set the default database name to 'test', specify:
defaultdatabase=test
Optional. Configuration of this keyword is optional.
Where configured. Configure this keyword in the Windows NT default-specific section [dbdfault], or in a Windows client's [winclient] section.
defaultpassword
Purpose. Specifies the default password, overriding the default of SYSADM. Default value. This keyword has no default value.
Example. To set the default password to 'secret', specify:
defaultpassword=secret
Where configured. Configure this keyword in the Windows NT default-specific section [dbdfault] or in a Windows client's [winclient] section.
defaultuser
Purpose. Specifies the default user name, overriding the default of SYSADM. Default value. This keyword has no default value.
Example. To set the default user name to 'admin', specify:
defaultuser=admin
Optional. Configuration of this keyword is optional.
Where configured. Configure this keyword in the Windows NT default-specific section [dbdfault] or in a Windows client's [winclient] section.
defaultwrite
Purpose. Controls whether changes to the values of the defaultdatabase,
defaultpassword, or defaultuser keywords are written to the configuration file.
Default value. Valid values are 0 (off) and 1 (on). The default is 1. Example. To set defaultwrite off, specify:
defaultwrite=0
This specifies that changes to the defaultdatabase, defaultpassword, and defaultuser keywords are in effect for the current session only and are not written to the configuration file.
When defaultwrite is on, changes to the default keywords are remembered by SQLBase for the current, and all future, sessions. As well, the specified changes are written to the configuration file.
Optional. Configuration of this keyword is optional.
Where configured. Configure this keyword in the Windows NT default-specific section [dbdfault] or in a Windows client's [winclient] section.
directsap
Purpose. Allows you to specify whether to use Novell’s Service Advertising Protocol (SAP) engine or the alternative Centura SAP engine for the SQLBase Server for NetWare 4.x.
Under NetWare 4.x, the Novell SAP engine has a maximum of 20 SAPs. This means that if you have more than 15 databases installed and you try to connect to additional
Configuration keywords
databases, the connection fails. Using the Centura SAP engine removes this limitation.
The syntax of this keyword is:
directsap=n
where n is either 0 (use Novell’s SAP engine) or 1 (use Centura’s SAP engine). Example. To use Centura’s SAP engine, specify:
directsap=1
Default value. The default is 0.
Optional. Configuration of this keyword is optional.
Where configured. Configure this keyword in the SPX section for the SQLBase Server for NetWare 4.x, for example, [dbnwsrv.spx] for the unlimited version). This keyword is not applicable to the SQLBase Server for NetWare 3.x, since there is no SAP limit under NetWare 3.x.
disablelogspacecheck
Purpose. Disables SQLBase from checking log file space availability before a new log file is opened. SQLBase opens a new log file when the current one has reached its specified maximum size. If the log file space is inadequate to ensure database integrity should a system failure occur, SQLBase selectively rolls back any
transaction that is causing excessive logging. SQLBase issues an error message that informs you the transaction has been rolled back, asks you to check for free disk space, and warns of imminent system shut down if the roll back does not recover log disk space.
By default, LOBACKUP is off, so that SQLBase deletes log files without backups as soon as they are not needed to perform transaction rollback or crash recovery. This prevents log files from accumulating and filling up the disk. When
disablelogspacecheck is enabled, be sure to set LOGBACKUP to off; otherwise,
SQLBase is unable to attempt recovery of log disk space. To set LOGBACKUP, use the SQLTalk SET LOGBACKUP command or the sqlset API function.
Example. The syntax is:
disablelogspacecheck=n
Default value. When this keyword is not declared, the default behavior is to perform checking for available log file space. Otherwise, to specify the default behavior, the value is 0. To disable checking, the value is 1.
Example. To disable checking for available log file space, specify:
Optional. Configuration of this keyword is optional.
Where configured. Configure this keyword in the server section of the
configuration file (sql.ini). This keyword is not applicable to Windows 3.x and on any partitioned database.
displevel
Purpose. Specifies the level of information (0-4) displayed on the Process Activity window. Set the display level with either the Level menu on the GUI server, the SQLTalk SET PRINTLEVEL command, or the sqlset SQL/API call in conjunction with the SQLPPLV parameter.
Example. The syntax is:
displevel=n
Optional. Configuration of this keyword is optional.
Where configured. This keyword is configured automatically in the server’s GUI section (for example, [dbntsrv.gui]) when you use the Save Settings option in the server’s File menu. Do not set a value for this keyword manually.
errorfile
Purpose. Specifies a file that contains entries to translate standard SQLBase return codes into user-defined return codes.
Default value. This keyword does not have a default value. Example. The syntax is:
errorfile=filename
where filename includes the full path.
The maximum length of the errorfile value is 260 characters. The maximum number of characters allowed in an errorfile directory path (excluding the filename which has a limit of eight characters and a three-character extension) is 246. This includes the drive letter, colon, leading backslash, and terminating null character.
Semicolons and commas cannot be part of the pathname. A directory name enclosed in single quotes can contain an embedded single quote which is indicated by TWO single quotes (for example: D:\'''test'''\).
Note: Characters reserved in the Windows environment cannot be used in directory or file
names; for example: <> : “ / \ |. Words reserved in the Windows environment cannot be used as filenames; for example, con or aux.
Configuration keywords
The file contains entries for error code translation in the form:
sbrcd,udrcd
where sbrcd is a SQLBase return code found in error.sql, and udrcd is a user-defined return code. The sbrcd value must be a positive integer; the udrcd can be a positive or negative integer. There can be no white space between the values or after the comma. The client application converts the sbrcd value to the udrcd value using the sqltec API function. For example, SQLBase returns a value of '1' to indicate an end-of-fetch condition, while DB2 returns a value of '100'. If you want an application to convert all SQLBase return codes of '1' to '100', the entry in the errorfile would look like this:
1,100
When your application calls the sqltec function, if the SQLBase return code doesn't exist, SQLBase returns a non-zero return code that means that the translation did not occur.
To force translation to occur, you can create a global translation entry using the asterisk (*) character and a generic return code (like '999'). For example, assume we created an errorfile of SQLBase return codes and corresponding DB2 return codes. For those SQLBase return codes that have no corresponding DB2 return code, you can force the application to return the generic return code '999' with the following entry:
*,999
Optional. Configuration of this keyword is optional.
Where configured. Configure this keyword in the Windows NT default-specific section [dbdfault], or in a Windows client's [winclient] section.
extdll
Purpose. Specifies the pre-loading of DLLs at server startup time. Because of the enormous overhead involved in making calls to the Microsoft API function load library, (especially in the case of large DLLs or DLLs that cause more DLLs to be loaded), pre-loading DLLs saves overhead and guarantees that the DLL is loaded as long as the server is running.
Note: If you have a DLL that uses global variables that can be accessed from different functions
or from multiple invocations of a function, you must load the DLL at server start up.
If you want to pre-load more than one DLL, you can specify the parameter multiple times within the server section. Each DLL entry must be on a separate line.
Default value. By default, SQLBase loads the DLL at function call time by calling the Microsoft API function Load Library.
Example. The syntax is:
EXTDLL=dllname
where dllname is a full path or the Operating System uses the path environment variable to locate dllname. If the DLL name is not qualified, the Operating System uses the path environment variable to locate the DLL.
The maximum length of the extdll value is 260 characters. The maximum number of characters allowed in the extdll directory path (excluding the filename which has a limit of eight characters and a three-character extension) is 246. This includes the drive letter, colon, leading backslash, and terminating null character.
Semicolons and commas cannot be part of any pathname. Semicolons are used as path delimiters, while commas are used as special characters to separate each parameter of a keyword in sql.ini. A directory name enclosed in single quotes can contain an embedded single quote which is indicated by TWO single quotes (for example: D:\'''test'''\.
Note: Characters reserved in the Windows environment cannot be used in directory or file
names; for example: <> : “ / \ |. Words reserved in the Windows environment cannot be used as filenames; for example, con or aux.
Optional. Configuration of this keyword is optional.
Where configured. Add the EXTDLL=dllname keyword to the dbwservr or dbntsrv (whichever applies to your environment) server section of the sql.ini file.
fileaccess
Purpose. Allows or disallows a user ability to access and modify files on a remote server machine. Use the fileaccess keyword with any function that allows remote access to any type of remote file.
Default value. The default for this keyword is compatible with the existing behavior of database servers.
Example. The syntax is:
sqlmwr fileaccess=0
Where sqlmwr is a function for writing to a remote server file. Setting fileaccess=0 disallows the user to write to a remote server file. (fileaccess=1 allows the user to
Configuration keywords
Optional. Configuration of this keyword is optional.
Where configured. Configure this keyword in the server section of the sql.ini file on the server machine in association with a file access function.
groupcommit
Purpose. Specifies the maximum number of COMMITs that SQLBase groups together before physically writing them to disk. Commits are performed when:
• The number of grouped commits exceeds the value of groupcommit, or • The number of ticks that have elapsed since the last commit is greater than the
value of groupcommitdelay. Read the groupcommitdelay description in the next section for more information on the groupcommitdelay keyword. SQLBase tries to economize resources and increase transaction rates by grouping COMMITs from several transactions into one transaction log entry, and performing them all in one physical write. It does this by pausing for a fraction of a moment in anticipation of other incoming COMMIT requests. SQLBase does not defer COMMITs; it always writes a COMMIT to disk before returning control to the user. Default value. The default value is 1.
Example. To set the maximum to 5, specify:
groupcommit=5
Optional. Configuration of this keyword is optional.
Where configured. Configure this keyword in the server section of the configuration file (sql.ini).
groupcommitdelay
Purpose. Specifies the maximum number of system ticks that SQLBase waits before performing commits. The duration of a system tick is platform-dependent, but is approximately 1/20 of a second.
Commits are performed when:
• The number of grouped commits exceeds the value of groupcommit, or • The number of ticks that have elapsed since the last commit is greater than the
value of groupcommitdelay.
Read the groupcommit description in the previous section for more information on the
groupcommit keyword.
Example. To set the groupcommitdelay to 20, specify:
groupcommitdelay=20
Optional. Configuration of this keyword is optional.
Where configured. Configure this keyword in the server section of the configuration file (sql.ini).
inmessage
Purpose. Sets the size (in bytes) of the input message buffer. The input message buffer holds input to the application (such as the result of a query).
There is one input message buffer per connected cursor on the client computer. The database server maintains a buffer that is the size of the largest input message buffer on the client computer. The server builds a message in its buffer, then sends it across the network to the client's input message buffer. It is called an input message buffer because it is input from the client's perspective.
Default value. By default, SQLBase maintains an input message buffer large enough to hold at least one row of data. Despite the inmessage value, SQLBase dynamically allocates more space if necessary.
When fetching data, SQLBase compacts as many rows as possible into the input message buffer. Each fetch reads the next row from the buffer until all have been read. At this point, SQLBase transparently fetches another buffer- ful of rows, depending on the isolation level.
A large input message buffer can improve performance when reading long varchar data and while fetching data because it reduces the number of network messages between the client and server. A large buffer can have a negative impact on
concurrency, however, because any row currently in the buffer can have a shared lock on it (depending on the isolation level) which prevents other users from changing that row. Read the sqlsil documentation in the SQLBase Application Programming
Interface Reference for more information about how each isolation level uses the
input message buffer.
Example. To set the size of the input message buffer to 5,000 bytes, specify:
inmessage=5000
Optional. Configuration of this keyword is optional.
Where configured. Configure this keyword in any client router section of the configuration file (sql.ini), except for the Windows NT platform.
Configuration keywords
insertioncontext
Purpose. Allows you to specify where in the NDS Tree the SQLBase server and database objects are to reside.
The syntax for this keyword is: insertioncontext=object_name
where object_name can be a complete or partial object name. If you use a complete object name you provide the path from the root of the NDS Tree to the particular object. Standard abbreviations for commonly used name types are:
Note: If you are specifying a search context for client users, be sure the searchcontext
keyword in the client sections of sql.ini are set to the same value as the insertioncontext
keyword.
Example. To specify that the SQLBase server and database objects reside in a part of the Directory Tree identified as CN=SERVERxx, you enter:
[dbnwsrv]
insertioncontext=CN=SERVERxx.OU=SQLBASE.OU=Menlo.O=Centura
Note that each path entry is separated by a period. No period is required if you are providing only one path entry, or if you are terminating the path entries. You may also provide a partial object name.
Default value. If you do not specify this keyword, the default context of the user specified by the ndsloginid keyword is used for insertion.
2EMHFWW\SH $EEUHYLDWLRQ &RXQWU\ & 2UJDQL]DWLRQ1DPH 2 2UJDQL]DWLRQDO8QLW 28 1DPH 1 /RFDOLW\1DPH / &RPPRQ1DPH &1 6WDWHRU3URYLQFH 1DPH 6 6WUHHW$GGUHVV 6$
Optional. Configuration of this keyword is optional.
Where configured. For SQLBase Server for NetWare 4.x, configure this keyword in the server section of the configuration file (sql.ini).T his keyword is not applicable to the SQLBase Server for NetWare 3.x.
listenport
Purpose. Identifies the port number on which a server listens for connections. On a given machine, a SQLBase server obtains exclusive use of the identified port. You must ensure that the port chosen does not conflict with other applications on the same machine.
If you specify this keyword, client applications connecting to this server must use the same port number with the serverpath keyword in their corresponding client section. If you specify listenport in a client section, you will receive an error.
Contact your network administrator if you do not know what port value to use for this keyword.
Default value. The default port number is 2155. The format of this keyword is:
listenport=n
where n is a positive integer not greater than 32767.
Example. To set the port Number to 3000, enter the following line:
listenport=3000
Optional. This keyword is optional.
Where configured. Configure this keyword in a server’s TCP/IP section of the sql.ini file. For the Windows NT and Windows 95 platforms, this is
[servername.ws32], for example, [dbntsrv.ws32]. For the NetWare platform, this is [servername.tip], for example, [dbnservr.tip].
listenretry
Purpose. Specifies the number of times a server should retry a listen when an attempt to listen on the network fails.
Default value. The default value of this keyword is 3. Example. To set the number of retries to 5, specify:
listenretry=5
Configuration keywords
Where configured. Configure this keyword in a multi-user server’s
communications section (for example, [dbntsrv.ntnbi]) of the configuration file (sql.ini).
locks
Purpose. Specifies the maximum number of lock entries to allocate. SQLBase