Skip to content
≡

Admin

Developer

Tools

External Tools

Preface#

About This Manual#

This manual describes how to use the Altibase API.

Audience#

This manual has been prepared for the following users of Altibase:

  • Database administrators
  • Performance administrators
  • Database users
  • Application developers
  • Technical Supporters

It is recommended for those reading this manual possess the following background knowledge:

  • Basic knowledge in the use of computers, operating systems, and operating system utilities
  • Experience in using relational database and an understanding of database concepts
  • Computer programming experience
  • Experience in database server management, operating system management, or network administration

Organization#

This manual is organized as follows:

  • Chapter 1: PHP Interface
    This chapter explains how to integrate PHP pages with Altibase using ODBC functionality of PHP.

  • Chapter 2: PDO Driver
    This chapter explains how to use the Altibase PDO driver to interact with Altibase. The Altibase PDO driver (pdo_altibase) is available as a pecl package from the official Altibase site.

  • Chapter 3: XA Interface
    This chapter introduces the data structures and functions that are needed to use the XA functions supported by Altibase and provides basic procedures for using ODBC, APRE and JDBC in an XA environment.

  • Chapter 4: iLoader API
    This chapter introduces the Altibase iLoader API, which is an application programming interface that lets you create applications that use function calls to download data from, or upload data to, an Altibase database server.

  • Chapter 5: CheckServer API
    This chapter introduces the Altibase CheckServer API, which is an application programming interface for creating applications that use function calls to monitor whether the Altibase server has terminated abnormally.

  • Chapter 6: Altibase ADO.NET

This chapter introduces Altibase ADO.NET, a driver that enables access to the Altibase server from .NET Core-based application, and ADO.NET APIs implemented in Altibase ADO.NET.

Documentation Conventions#

This section describes the conventions used in this manual. Understanding these conventions will make it easier to find information in this manual and in the other manuals in the series.

There are two sets of conventions:

  • Syntax diagram conventions
  • Sample code conventions

Syntax Diagram Conventions#

This manual describes command syntax using diagrams composed of the following elements:

Elements Meaning
image1 Indicates the start of a command. If a syntactic element starts with an arrow, it is not a complete command.
image2 Indicates that the command continues to the next line. If a syntactic element ends with this symbol, it is not a complete command.
image3 Indicates that the command continues from the previous line. If a syntactic element starts with this symbol, it is not a complete command.
image4 Indicates the end of a statement.
image5 Indicates a mandatory element.
image6 Indicates an optional element.
image7 Indicates a mandatory element comprised of options. One, and only one, option must be specified.
image8 Indicates an optional element comprised of options.
image9 Indicates an optional element in which multiple elements may be specified. A comma must precede all but the first element.

Sample Code Conventions#

The code examples explain SQL statements, stored procedures, iSQL statements, and other command line syntax.

The following table describes the printing conventions used in the code examples.

Rules Meaning Example
[ ] Indicates an optional item VARCHAR [(size)] [[FIXED |] VARIABLE]
{ } Indicates a mandatory field for which one or more items must be selected. { ENABLE | DISABLE | COMPILE }
| A delimiter between optional or mandatory arguments. { ENABLE | DISABLE | COMPILE } [ ENABLE | DISABLE | COMPILE ]
. . . Indicates that the previous argument is repeated, or that sample code has been omitted. SQL> SELECT ename FROM employee;
ENAME
-----------------------
SWNO
HJNO
HSCHOI
.
.
.
20 rows selected.
Other Symbols Symbols other than those shown above are part of the actual code. EXEC :p1 := 1; acc NUMBER(11,2)
Italics Statement elements in italics indicate variables and special values specified by the user. SELECT * FROM table_name;
CONNECT userID/password;
Lower case words Indicate program elements set by the user, such as table names, column names, file names, etc. SELECT ename FROM employee;
Upper case words Keywords and all elements provided by the system appear in upper case. DESC SYSTEM_.SYS_INDICES_;

For more detailed information, please refer to the following documents.

  • Installation Guide

  • Administrator’s Manual

  • Replication Manual

  • CLI User's Manual

  • Precompiler User’s Manual

  • ODBC User's Manual

  • iSQL User’s Manual

  • Utilities Manual

  • Error Message Reference

Altibase Welcomes Your Comments and Feedbacks#

Please let us know what you like or dislike about our manuals. To help us with better future versions of our manuals, please tell us if there is any corrections or classifications that you would find useful.

Include the following information:

  • The name and version of the manual that you are using
  • Any comments about the manual
  • Your name, address, and phone number

If you need immediate assistance regarding any errors, omissions, and other technical issues, please contact Altibase's Support Portal.

Thank you. We always welcome your feedbacks and suggestions.