Using the Cloudscape Documentation

Transcription

1 Using the Cloudscape Documentation The Cloudscape Documents on page 1 Documentation Conventions on page 4 Further Reading on page 6 The Cloudscape Documents The Books on page 1 Getting PDF Versions of the Documentation on page 3 About the HTML Directory on page 4 The Books The Cloudscape installation includes the following books: Getting Started with Cloudscape The book you should read first after you install the software. It helps you with basic tasks such as setting the class path and finding the example programs. For previous users, it also lists new features and changes. 1

2 2 (this book) Information about the Cloudscape documentation set, how to get PDF versions of the books, an explanation of the documentation conventions, and suggestions for further reading. Master Index to the Cloudscape Documentation A global index to your entire documentation set. Learning Cloudscape: The Tutorial A tutorial for Cloudscape beginners. Takes you step-by-step through Cloudscape and Cloudscape application basics such as creating databases, connecting, querying, working with dictionary objects, and inserting and updating data. This book includes a glossary. Cloudscape Developer s Guide Describes the functionality and features of the core Cloudscape product that are common to all deployments, such as Cloudscape s JDBC and SQL specifics, deploying Cloudscape applications, security, and other advanced features. Cloudscape Reference Manual A reference for the core SQL-J language, Cloudscape s Java-enhanced dialect of SQL. Also provides reference information for Cloudscape s JDBC and JTA implementations, keywords, system tables, properties, and SQLExceptions. (Reference information for synchronization-specific features is in the Cloudscape Synchronization Guide.) Tuning Cloudscape Explains how to configure and tune Cloudscape through properties and provides reference information on properties. It also offers performance tips, an in-depth discussion of performance, and information about the Cloudscape optimizer. Cloudscape Tools and Utilities Guide A manual for working with the Cloudscape tools such as ij and Cloudview and more advanced utilities such as import/export and the database class loader. Cloudscape Server and Administration Guide Cloudconnector (purchased separately) and the RmiJdbc framework (available with Cloudscape) are server frameworks that allow network connections to Cloudscape. They may require some additional configuration or administration steps. Client applications connecting to these servers over the network specify some details differently from applications using Cloudscape in the embedded mode, such as driver and

3 The Cloudscape Documents 3 database connection URL. Part One of this book discusses configuration of servers, how to program client applications, and database administration. In addition, some systems may require administrative tasks such as backing up databases. These tasks are independent of any server framework but are unique to multi-user or large systems. Part Two of this book discusses administrative issues such as backups and debugging deadlocks. Cloudscape Synchronization Guide Only users who purchase Cloudsync receive this book. Explains how to use the Cloudscape synchronization technology to distribute and synchronize applications and their data. Your installation includes all books in HTML format. You can view them with any Web browser. Getting PDF Versions of the Documentation The documents are also available in PDF format on the Cloudscape Web site. You can view them with the freely distributed program Adobe Acrobat Reader or print out a hard copy. You need Adobe Acrobat Reader version 3.0 or greater in order to view and print out the PDF documents. NOTE: To download the PDF documents, go to support/downloads/. The HTML versions of the documents are more suited to on-line browsing; the PDF versions are more suited to printing out and reading in hardcopy. However, the PDF versions have one nice on-line feature: You can do a text search of an entire document using Acrobat Reader s Find command. In addition, the PDF cross-references to a page within the current book are hyperlinks. That means that they act like a link in an HTML page: If you click on the cross-reference, the browser takes you there. Cross-references to pages within a different book are not hyperlinks (you cannot click on them to follow the link). If you download the PDF versions of the documents, place them in the /pdf subdirectory under /doc. Cloudscape Version 3.0

4 4 About the HTML Directory The HTML version of each book is in the /doc/html subdirectory of the cloudscape base directory. Inside that subdirectory: /coredocs contains the Cloudscape Reference Manual, the Cloudscape Developer s Guide, and Tuning Cloudscape. /hub contains the Cloudscape Server and Administration Guide. /rep contains the Cloudscape Synchronization Guide. /tools contains the Cloudscape Tools and Utilities Guide. /tutorial contains Learning Cloudscape: The Tutorial. The outermost directory contains the files that make up Getting Started with Cloudscape and the global index. Documentation Conventions Terminology on page 4 discusses the use of certain terminology. Syntax on page 5 explains how syntax is presented. Typography on page 6 discusses typographical conventions in this document. Terminology The Cloudscape documentation uses some specialized vocabulary. Here are some definitions that will help you understand Cloudscape: environment embedded environment client/server environment How your application interacts with Cloudscape. Sometimes referred to as a framework. The two environments are embedded environment and client/server environment. When an application starts up an instance of Cloudscape within its JVM, the application is said to run in an embedded environment. In this environment, only a single application can connect to a database at one time, and no network access occurs. When multiple applications connect to Cloudscape over the network, they are said to run in a client/server environment. Cloudscape runs embedded in a server or connectivity framework that allows multiple network connections. (The frame-

5 Documentation Conventions 5 work itself starts up an instance of Cloudscape and, strictly speaking, it is running in an embedded environment; the client applications, however, are not.) This documentation set includes a glossary at the back of the book Learning Cloudscape: The Tutorial. See that glossary if you have other questions about terminology. Syntax SQL-J syntax is presented in modified BNF notation. The meta-symbols of BNF are: Symbol Meaning or. Choose one of the items [ ] Enclose optional items. * Flags items that you can repeat 0 or more times. Has a special meaning in some SQL-J statements. { } Groups items so that they can be marked with one of the other symbols, i.e. [ ],, or *. Other punctuation that is part of the syntax. ( )., An example of how SQL-J syntax is presented: CREATE [ UNIQUE ] [ BTREE ] INDEX IndexName ON TableName ( SimpleColumnName [, SimpleColumnName ] * ) Command-line syntax for running Java programs and utilities (as well as examples) always begins with the word java. Substitute for the word java the executable for the JVM you wish to use. For example: could be: java COM.cloudscape.tools.ij jview COM.cloudscape.tools.ij In addition, this documentation uses the JavaSoft/SunSoft style for setting JVM arguments and properties. If you use another JDK, the way you set JVM arguments and properties may be different. Cloudscape Version 3.0

6 6 Typography This manual uses some typographical conventions to highlight elements of the SQL-J language, operating system commands, the Java programming language, and the like. Typeface Usage Examples Italic New terms defined by keys File and directory names C:\cloudscape Java class names, objects, and PreparedStatement methods Dictionary objects The Hotels table In syntax, items that you do CREATE TABLE tablename not type exactly as they appear, but replace with the appropriate name Bold, fixed-width SQL-J examples SELECT city.getname() FROM Cities Java application examples Connection conn = DriverManager.getConnection ("jdbc:cloudscape:toursdb") Roman, fixed-width Comments within examples --This line ignored All caps SQL-J keywords (commands) You can use a CREATE TABLE statement Further Reading SQL and SQL-92 on page 6 Java on page 7 JDBC and the java.sql API on page 7 SQL and SQL-92 Understanding the New SQL: A Complete Guide. Melton and Simon. Morgan Kaufmann Publishers, Inc.: ( books_catalog/ asp)

7 Further Reading 7 An effective introduction to SQL-92, and a comprehensive reference. With the exception of its Java extensions and stored prepared statements, the SQL-J language uses SQL-92 entry functionality for its specification. Java Java in a Nutshell. Flanagan. O Reilly & Associates: ( An advanced introduction to Java for C and C++ programmers, with a complete quick-reference for all of the classes in the Java 1.1 API. Thinking in Java. Eckel. Prentice-Hall: ( and / The JDK tool set and how to specify options such as properties. java.util.properties.html, api/java.util.properties.html, docs/api/java.lang.system.html, and jdk/1.2/docs/api/java.lang.system.html Java properties and how to specify them programmatically and with properties files. and index.html. Serialization and the java.io.serializable API. JDBC and the java.sql API JDBC Database Access with Java. Hamilton, Cattell, and Fisher. Addison Wesley: ( An introduction with a tutorial. Database Programming with JDBC and Java. Reese. O Reilly & Associates: ( JDBC and the java.sql API ( Cloudscape Version 3.0