OceanBase
English日本語简体中文
Docs Home
Products
Integrations
Release Notes

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog ServiceOceanBase DataPilot

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog ServiceOceanBase DataPilot
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

Embedded SQL in C for OceanBase

V1.1.7Enterprise Edition
  • What's New
  • What is ECOB?
  • ECOB compatibility with Pro*C
  • Install ECOB
  • Data types and variables
    • Overview
    • Supported data types
    • Data type conversion
    • Indicator variable
    • VARCHAR variable
    • Structure
    • String pointer
  • Embedded SQL statements
    • Overview
    • Variable declaration
    • Connect to OceanBase databases
    • Basic SQL statements
    • Prepared statements
    • Stored procedures
    • Cursor
    • Simple dynamic SQL statement
    • ANSI dynamic SQL statements
    • Error handling
      • SQLCA structure
      • WHENEVER statement
    • LOB-related SQL statements
  • Use ECOB
    • Environment preparation
    • Use ECOB
    • Compile the Tuxedo service
  • Command Line Options

Download PDF

Document Feedback
  1. Documentation Center
  2. Embedded SQL in C for OceanBase
  3. V1.1.7

SQLCA structure

Last Updated:2026-09-04 08:37:38

Members of the SQLCA structure
sqlgls function
sqlglm function

OceanBase Embedded SQL in C (ECOB) implements the SQL Communications Area (SQLCA) structure. You do not need to explicitly use the #include<sqlca.h> or EXEC SQL INCLUDE SQLCA statement.

Members of the SQLCA structure

The SQLCA structure comprises several members, including sqlcode, sqlerrm, and sqlerrd.

Values and descriptions of sqlcode:

  • The value 0 indicates statement execution success.

  • When the value is less than 0, the statement failed to be executed in OceanBase Database. The specific error code may be different from that in Oracle. This error can be determined on the application side if the value of sqlca.sqlcode is less than 0.

  • When the value is greater than 0, no proper data is found from the database. In ECOB V1.1.0, only one value is supported to be greater than 0, which is 1403. In this case, the error message is DATA NOT FOUND.

sqlerrm contains the sqlerrml and sqlerrmc members. The sqlerrml member stores the length of the error message, and the sqlerrmcmember stores the error message.

sqlerrd is a long array whose length is 6. If its subscript is 0, 1, 3, 4, or 5, the element value is NULL. If its subscript is 2, the element stores the number of rows processed by the INSERT, UPDATE, and DELETE statements.

sqlgls function

You can call this function to get the SQL statement executed the last time.

Syntax:

int sqlgls(char *sqlstm, size_t *stmlen, size_t *sqlfc);

sqlstm indicates the SQL statement. stmlen indicates the length of the SQL statement. sqlfc indicates the SQL function code.

sqlglm function

You can call this function to get the error message if the statement executed the last time failed.

Syntax:

void sqlglm(char *message_buffer,size_t *buffer_size,size_t *message_length);

buffer_size indicates the maximum length of the buffer. message_length indicates the actual length of the error message.

Previous topic

ANSI dynamic SQL statements
Last

Next topic

WHENEVER statement
Next
on this page
Members of the SQLCA structure
sqlgls function
sqlglm function