Copyright © 1996-2001, SNAP Innovation Softwareentwicklungsgesellschaft mbH. All rights reserved.
PrimeBase SQL Database Server Reference Manual
Welcome to PrimeBase 4.0
PrimeBase is a development platform for the production of client/server and web applications. It consists of 3 main products: the PrimeBase Database Server, the PrimeBase Application Server, and the PrimeBase Open Server, all of which are based on open standards.
The PrimeBase Database Server is a relational Database Management System (DBMS) for Mac, UNIX and Windows platforms. The PrimeBase Database Server supports all common database access standards (SQL, ODBC, JDBC, EOF and DAL) and protocols (TCP/IP, Shared Memory and Appletalk).
The PrimeBase Application Server allows rapid development and deployment of Web applications. The PrimeBase Application Server has many features that make implementing a Web application simple and efficient, including: an object-oriented programming environment and framework and multi-processor capabilities to ensure unlimited scalability.
The PrimeBase Open Server allows the PrimeBase Application Server or other applications using the PrimeBase Virtual Machine to connect to alternate data sources via PrimeBase Open Server plug-ins loaded by the PrimeBase Open Server. For example the Oracle plug-in enables you to access an Oracle database, or by loading the ODBC plug-in you will be able to access data servers via their ODBC drivers.
The software, whether on CD or downloaded from the internet, is "pre-installed". This means it is ready for use within minutes, just copy the software to your machine, unpack and start the application.
Documentation for PrimeBase including reference manuals and user guides is provided in PDF (Portable Document Format) and may be read and printed using Adobe Acrobat available, free of charge, from http://www.adobe.com.
Should you still have problems with the installation of this software, or you have any other questions then you are free to contact us by telephone at ++ 49 40 306 39 400 or via e-mail: support@primebase.com. If you have general support questions that may be interesting to the entire PrimeBase community, then we suggest you visit our Web-site, www.primebase.com, and join our mailing list.
For a more detailed overview of the PrimeBase system we recommend that you read the PDF document: "PrimeBase System Overview"
Installing and Running the Data Server
Before starting the PrimeBase Database Server please read the license agreement at the end of this document. Only proceed to use the PrimeBase Database Server if you are in agreement with the terms of this license.
If you have not already done so, we recomend that you create a new user (by convention called 'snap') on your system for the PrimeBase software. Ensure that you have a least 20 MB of free disk space in the user's home directory.
This software is pre-installed so all you need to do is move this directory to the 'snap' user's home directory and start the database server executable (pbds).
Optionally you can install the exacutables and libraries into the directory specified by the environment variable PRIMEBASEHOME. If it is not defined then PRIMEBASEHOME defaults to /usr/local/primebase. The PRIMEBASEHOME directory must be created and given read, write, and execute privileges for all users who may use the PrimeBase software before doing the installation.
To install this package into PRIMEBASEHOME execute the file "Install_pbds". This will move the files to the correct locations inside of your PRIMEBASEHOME directory.
NOTE: You must start the server from this directory.
It is also recommended that ownership of all files in this directory (and sub-directories) is given to the user 'snap', and that the executables are started as the user 'snap'.
After you have started the server you may enter CTRL-R to detach the console, leaving the server running in the background. You may start the server immediately in the background by using the -b option, as follows:
./pbds -b
or use the 'start_data_server' shell script.
To attach a console to the application server running in the background, start the console (pbcon) program or use the 'data_server_console' script. The console executable may be started from any directory on the server machine.
You can shutdown the server by entering #halt at the console, or by running the 'stop_start_data_server' script.
Developer and Demo Versions
The software in this directory will run for a limited period only. The activation information, including the expiry date is stored in the file 'pbds.key' in this directory.
When the demo period has expired the server will still start but will not run for longer than 2 hours.
You may request an extension to this demonstration period for development purposes by sending an e-mail to support@primebase.com. Please state the nature and duration of you project.
We will send you a new 'pbds.key' file. To activate the server, replace the file in this directory and restart the server.
Server Default Setup
This server is pre-installed. The directory 'db' contains the databases currently mounted by the server. This includes the Master and Model databases.
The location of the Master database is also called the "server root" (or server root path).
The directory 'setup' contains the server environment file (pbds.env), which stores the location of the server root.
The default server root is 'db' which is a relative path (relative to the current working directory of the server process). As a result, it is important that when the server is started, it is started in the directory currently containing the server executable.
The server has been installed with the following defaults for system administrator and server name:
* User Name & Password:
The server is maintained by the "System Administrator", who has all privileges and access rights. By default the user name of the system administrator for the server is:
Administrator
with no password.
To login to the server, use the name 'administrator' (user names are not case-sensitive) and no password.
Once you have installed your server, we recommend that you connect to the Admin Server using a browser as describe above, and set the system administrator's password.
If you wish to alter the name of the system administrator then you can create a new user in the Master database, and grant the user SA privileges using the Admin Server.
* The Server Name:
The server has the name 'PrimeServer' by default. If you wish to run more than one server you will need to change the server's name.
To change the server name, login to the Admin Server and click on the server name to change it. The Admin Server will require you to login to the server as a system administrator (default name 'Administrator', with no password).
Using Server Scripts
You will find some useful PrimeBase scripts in the 'setup/scripts' directory. To run a script, login at the server console (start the console executable if necessary) and enter:
execute file "<script name>";
then CTRL-G, to execute a script.
Network Communications
By default the server communicates over TCP directly rather than using a "cpo" process. The advantage of this is that communication speed is some what improved. The disadvantage is that each TCP connection uses a file handle which may impact server performance or limit the number of connections that you can have open if you have a lot of users connected (>100).
If this becomes a problem edit the server environment file using 'pbee' and set the environment variable 233 to a value other than zero then restart the server. The server will now access TCP via a cpo process.
You can prevent the server from publishing its self over TCP or ADSP by using 'pbee' to set the environment variable 231 or 232 to a non zero value to prevent the server from publishing its self over TCP or ADSP respectively.
When the PrimeBase Database Server starts it automatically starts the Administration Server (dsa) as well.
You can connect to the Admin Server using a JavaScript capable browser (Version 3.0 or later of Netscape Navigator or MS Internet Explorer).
The default URL is http://<host_ip_address>:46914
<host_ip_address> is the TCP/IP address or host name of the machine on which the database server is running. You can use 'localhost' or '127.0.0.1' if the browser and database server are running on the same machine.
When the Admin Server is accessed for the first time, a password must be provided. This password must be entered in a file called "password.adm", which gets created in the database server directory. Edit this file with an editor of your choice to contain the password you like to set up for the Admin Server, and use this password in the initial password dialog of the Admin Server. NOTE: This is the password for access to the Admin Server only. After connecting to the Admin Server you will be required to login to the PrimeBase Server as "System Administrator".
If the PrimeBase Data Server is running on the same machine as your browser you can use this link to access the Admin Server: Admin Server
If you do not want the server to start the Admin Server then remove 'dsa' from the server folder.
This is a legal agreement between you, the end-user, and SNAP Innovation Software GmbH("SNAP"). By installing a SNAP software program (the "Software") with an installer, or by copying the software to your computer, you are agreeing to be bound by the terms of this agreement. If you do not agree to these terms, promptly return the disk package and the accompanying items to the place you obtained them for a full refund.
SNAP grants you the right to use one instance of the PrimeBase Database or Application Server for each unique serial number issued. The total number of simultaneous connections may not exceed the number encoded in the activation key. You may run the server on any one of the platforms encoded in the activation key. If a temporary license has been granted the Software may not be used beyond the indicated expire date.
You may use any number of instances of the client software on any platform on which it is available.
The Software is owned by SNAP and is protected by the German copyright law and all other applicable law. You may not decompile, reverse engineer, disassemble, patch or modify the Software. You may not rent or lease the Software, but you may transfer your rights under this SNAP License Agreement on a permanent basis provided you transfer all copies of the Software and all written materials, and the recipient writes to SNAP accepting all the terms of this Agreement. Any transfer must include the most recent update and all prior versions.
SNAP shall not be liable for any damages whatsoever (such as damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or inability to use this software.
This license is governed by the laws of the Federal Republic of Germany.
PrimeBase, the PrimeBase logo and the SNAP logo are trademarks of SNAP Innovation Softwareentwicklungsgesellschaft mbH. Copyright © 1997 SNAP Innovation Softwareentwicklungsgesellschaft mbH. All rights reserved.