Skip to content
≡

Admin

Developer

Tools

External Tools

Preface#

About This Manual#

This manual describes how to use Altibase CLI.

Audience#

This manual has been prepared for the following Altibase users:

  • 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: Altibase CLI Introduction
    This chapter briefly introduces the background of Altibase CLI, how to use it, its programming steps, and more.

  • Chapter 2: Altibase CLI Functions
    This chapter provides the syntax, arguments, return value and an example for each Altibase CLI function.

  • Chapter 3: LOB Interface
    This chapter describes the functions and data types necessary for using LOB data.

  • Appendix A. Sample Codes
    This appendix shows all the sample codes used in this document.

  • Appendix B. Data Type
    This appendix explains the Altibase SQL data types, C data types, and the conversionpossibilities between the data types.

  • Appendix C. Error Codes
    This appendix categorizes the errors which occur while using Altibase CLI to their SQLSTATE, and explains them.

  • Appendix D. Upgrade
    This appendix describes the data types which were added or redefined and other changes that were made to enable the use of ODBC applications that were used in the previous version, prior to the upgrade.

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 convetions
  • 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 taht the command continues from the previous line. If a syntactic element starts witht his symbol, it is not a complete command.
image4 Indicates the end of a statement.
image5 Indicates a manatory 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 comman 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

  • Precompiler User’s Manual

  • ODBC User's Manual

  • Application Program Interface 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.