Oracle8i JDBC developer's guide and reference

Contents......Page 3
List of Tables......Page 20
Send Us Your Comments......Page 21
Documentation Accessibility......Page 23
Structure......Page 24
Related Documents......Page 25
Conventions......Page 27
Overview of the Oracle JDBC Drivers......Page 33
Common Features of Oracle JDBC Drivers......Page 34
JDBC OCI Driver......Page 35
JDBC Server-Side Internal Driver......Page 36
Applets and Security......Page 37
Session and Transaction Context......Page 38
JDBC and IDEs......Page 39
New Features......Page 40
Desupported Features......Page 42
Interface Changes......Page 43
Verifying a JDBC Client Installation......Page 45
Check Installed Directories and Files......Page 46
JDBC Thin Driver......Page 47
Testing JDBC and the Database Connection: JdbcCheckup......Page 48
A Brief Overview of Oracle Datasource Support for JNDI......Page 51
DataSource Properties......Page 52
Initialize Connection Properties......Page 56
Logging and Tracing......Page 57
Database Specifiers......Page 58
Thin-style Service Name Syntax......Page 59
TNSNames Alias Syntax......Page 60
First Steps in JDBC......Page 61
Specifying a Database URL, User Name, and Password......Page 62
Supported Connection Properties......Page 63
Bequeath Connection and Sys Logon......Page 66
Remote Connection......Page 67
Creating a Statement Object......Page 68
Closing the Result Set and Statement Objects......Page 69
Committing Changes......Page 70
Sample: Connecting, Querying, and Processing the Results......Page 71
Table of Mappings......Page 72
Java Streams in JDBC......Page 74
LONG Data Conversions......Page 75
Getting a LONG RAW Data Column with getBinaryStream()......Page 76
Getting a LONG RAW Data Column with getBytes()......Page 77
Data Streaming and Multiple Columns......Page 78
Bypassing Streaming Data Columns......Page 79
Closing a Stream......Page 80
Streaming Data Precautions......Page 81
PL/SQL Stored Procedures......Page 82
Processing SQL Exceptions......Page 83
Printing the Stack Trace......Page 84
Introduction......Page 87
Standard versus Oracle Performance Enhancement APIs......Page 88
Overview of Supported JDBC 3.0 Features......Page 89
Creating a Savepoint......Page 90
Savepoint Interfaces......Page 91
JDBC 3.0 LOB Interface Methods......Page 92
Basics of Statement Caching......Page 95
Explicit Statement Caching......Page 96
Enabling and Disabling Implicit Statement Caching......Page 97
Checking for Statement Creation Status......Page 98
Disabling Implicit Statement Caching for a Particular Statement......Page 99
Using Explicit Statement Caching......Page 100
Retrieving an Explicitly Cached Statement......Page 101
The Implicit Connection Cache......Page 103
Opening a Connection......Page 105
Implicit Connection Cache Example......Page 106
Getting Connections......Page 107
Setting Connection Attributes......Page 108
Limit Properties......Page 109
TimeToLiveTimeout......Page 110
Connection Property Example......Page 111
createCache......Page 112
enableCache......Page 113
getNumberOfActiveConnections......Page 114
Advanced Topics......Page 115
Connection Cache Callbacks......Page 116
Fast Connection Failover Prerequisites......Page 119
ONS Configuration File......Page 120
Using the oncstl Command......Page 121
Enabling Fast Connection Failover......Page 122
What The Application Sees......Page 123
Comparison of Fast Connection Failover and TAF......Page 124
Overview......Page 127
Distributed Transaction Concepts......Page 128
Mode Restrictions On Operations......Page 130
XA Datasource Interface and Oracle Implementation......Page 131
XA Connection Interface and Oracle Implementation......Page 132
XA Resource Interface and Oracle Implementation......Page 133
Start......Page 134
Prepare......Page 136
Recover......Page 137
XA ID Interface and Oracle Implementation......Page 138
XA Exception Classes and Methods......Page 139
Oracle XA Optimizations......Page 140
Oracle XA Code Sample......Page 141
Introduction to Oracle Extensions......Page 147
Support for Oracle Objects......Page 148
Support for Schema Naming......Page 149
Package oracle.sql......Page 150
Classes of the oracle.sql Package......Page 151
General oracle.sql.* Datatype Support......Page 152
Overview of Class oracle.sql.STRUCT......Page 153
Overview of Classes oracle.sql.BLOB, oracle.sql.CLOB, oracle.sql.BFILE......Page 154
Classes oracle.sql.TIMESTAMP, oracle.sql.TIMESTAMPTZ, and oracle.sql.TIMESTAMPLTZ......Page 155
Class oracle.sql.OPAQUE......Page 156
Package oracle.jdbc......Page 157
Client Identifiers......Page 158
Interface oracle.jdbc.OracleStatement......Page 159
Interface oracle.jdbc.OraclePreparedStatement......Page 160
Interface oracle.jdbc.OracleCallableStatement......Page 161
Class oracle.jdbc.OracleTypes......Page 162
OracleTypes and Registering Output Parameters......Page 163
Method getJavaSqlConnection()......Page 164
SQL NCHAR Datatypes......Page 165
oracle.sql.CHAR Objects and Character Sets......Page 166
Constructing an oracle.sql.CHAR Object......Page 167
Additional Oracle Type Extensions......Page 168
Oracle REF CURSOR Type Category......Page 169
Example: Accessing REF CURSOR Data......Page 170
Standard Types Versus Oracle Types......Page 173
Result Set and Statement Extensions......Page 174
Oracle getOracleObject() Method......Page 175
Summary of getObject() and getOracleObject() Return Types......Page 176
Other getXXX() Methods......Page 177
Return Types of getXXX() Methods......Page 178
Datatypes For Returned Objects from getObject and getXXX......Page 179
Example: Using setObject() and setOracleObject()......Page 180
Input Parameter Types of setXXX() Methods......Page 181
Setter Methods That Take Additional Input......Page 183
Example......Page 184
Using Result Set Meta Data Extensions......Page 185
Providing Globalization Support......Page 187
Compressing ora18n.jar......Page 188
NCHAR, NVARCHAR2, NCLOB and the defaultNChar Property......Page 189
JDBC Methods Dependent On Conversion......Page 190
Mapping Oracle Objects......Page 191
Standard java.sql.Struct Methods......Page 192
Steps in Creating StructDescriptor and STRUCT Objects......Page 193
Serializable STRUCT Descriptors......Page 194
Retrieving an Oracle Object as a java.sql.Struct Object......Page 195
STRUCT Automatic Attribute Buffering......Page 196
Creating and Using Custom Object Classes for Oracle Objects......Page 197
Understanding Type Maps for SQLData Implementations......Page 198
Adding Entries to an Existing Type Map......Page 199
Materializing Object Types not Specified in the Type File......Page 200
Implementing readSQL() and writeSQL() Methods......Page 201
Reading SQLData Objects from a Result Set......Page 202
Retrieving SQLData Objects from a Callable Statement OUT Parameter......Page 203
Writing Data to an Oracle Object Using a SQLData Implementation......Page 204
Understanding ORAData Features......Page 205
Retrieving and Inserting Object Data......Page 206
Reading Data from an Oracle Object Using a ORAData Implementation......Page 207
Writing Data to an Oracle Object Using a ORAData Implementation......Page 208
Additional Uses for ORAData......Page 209
Object-Type Inheritance......Page 210
Creating Subtypes......Page 211
Person.java using ORAData......Page 212
ORADataFactory Implementation......Page 213
Person.java using SQLData......Page 214
Student.java extending Student.java......Page 215
Retrieving Subtype Objects......Page 216
Using SQLData Mapping......Page 217
Using ORAData Mapping......Page 218
Sending Subtype Objects......Page 219
Subtype Data Fields from the getOracleAttribute() Method......Page 220
Inheritance Meta Data Methods......Page 221
Categories of SQL Types......Page 222
Mapping the Oracle object type to Java......Page 223
Summary of SQL Type Categories and Mapping Settings......Page 224
Functionality for Getting Object Meta Data......Page 225
Example......Page 226
Oracle Extensions for LOBs and BFILEs......Page 229
Example: Getting BLOB and CLOB Locators from a Result Set......Page 230
Passing BLOB and CLOB Locators......Page 231
Reading and Writing BLOB and CLOB Data......Page 232
Example: Reading CLOB Data......Page 233
Example: Writing CLOB Data......Page 234
Populating a BLOB or CLOB Column in a New Table......Page 235
Accessing and Manipulating BLOB and CLOB Data......Page 236
Additional BLOB Methods......Page 237
Additional CLOB Methods......Page 238
Shortcuts For Inserting and Retrieving CLOB Data......Page 239
Working With Temporary LOBs......Page 240
Using Open and Close With LOBs......Page 241
Example: Getting a BFILE locator from a Result Set......Page 242
Example: Passing a BFILE Locator to a Callable Statement......Page 243
Creating a BFILE Column in a New Table......Page 244
Populating a BFILE Column......Page 245
Additional BFILE Features......Page 246
Oracle Extensions for Object References......Page 249
Prepared and Callable Statement Setter Methods......Page 250
Retrieving an Object Reference from a Result Set......Page 251
Passing an Object Reference to a Prepared Statement......Page 252
Custom Reference Classes with JPublisher......Page 253
Choices in Materializing Collections......Page 255
Creating Collections......Page 256
Overview of Collection (Array) Functionality......Page 257
ARRAY Class Methods......Page 258
Accessing oracle.sql.ARRAY Elements as Arrays of Java Primitive Types......Page 259
ARRAY Automatic Indexing......Page 260
Steps in Creating ArrayDescriptor and ARRAY Objects......Page 261
Creating Multi-Level Collections......Page 262
Using ArrayDescriptor Methods......Page 263
Retrieving the Array......Page 264
getArray()......Page 265
Retrieving Elements of a Structured Object Array According to a Type Map......Page 266
Retrieving Array Elements into an oracle.sql.Datum Array......Page 267
Accessing Multi-Level Collection Elements......Page 268
Passing an Array to a Prepared Statement......Page 269
Using a Type Map to Map Array Elements......Page 270
Custom Collection Classes with JPublisher......Page 272
Result Set Functionality and Result Set Categories Supported in JDBC 2.0......Page 275
Updatability......Page 276
Oracle JDBC Implementation for Result Set Scrollability......Page 277
Implementing a Custom Client-Side Cache for Scrollability......Page 278
Specifying Result Set Scrollability and Updatability......Page 279
Result Set Limitations......Page 280
Verifying Result Set Type and Concurrency Type......Page 281
last() Method......Page 282
Methods for Checking the Current Position......Page 283
Presetting the Fetch Direction......Page 284
Performing a DELETE Operation in a Result Set......Page 285
Performing an UPDATE Operation in a Result Set......Page 286
Performing an INSERT Operation in a Result Set......Page 287
Update Conflicts......Page 288
Setting the Fetch Size......Page 289
Refetching Rows......Page 290
Seeing External Changes......Page 291
Visibility versus Detection of External Changes......Page 292
Oracle Implementation of Scroll-Sensitive Result Sets......Page 293
New Result Set Methods......Page 294
Statement Methods......Page 296
Database Meta Data Methods......Page 297
Introduction......Page 299
Row Set Listener......Page 300
Traversing Through the Rows......Page 301
Cached Row Set......Page 302
CachedRowSet Constraints......Page 305
JDBC Row Set......Page 306
OCI Driver Connection Pooling: Background......Page 307
Defining an OCI Connection Pool......Page 308
Creating an OCI Connection Pool......Page 309
Setting the OCI Connection Pool Parameters......Page 310
Connecting to an OCI Connection Pool......Page 311
Statement Handling and Caching......Page 312
Failover Type Events......Page 313
Java TAF Callback Interface......Page 314
HeteroRM XA Code Example......Page 315
Overview......Page 316
Binding IN Parameters......Page 317
Registering the OUT Parameters......Page 318
JDBC Default Mappings......Page 319
Java Primitive Type Mappings......Page 320
Overview......Page 323
JDBC OCI Instant Client Installation Process......Page 324
Patching Instant Client Shared Libraries......Page 325
Database Connection Names for OCI Instant Client......Page 326
Environment Variables for OCI Instant Client......Page 327
Introduction......Page 329
JDBC API For End-To-End Metrics......Page 330
Overview of Update Batching Models......Page 333
Types of Statements Supported......Page 334
Oracle Update Batching Characteristics and Limitations......Page 335
Setting the Statement Batch Value......Page 336
Overriding the Batch Value......Page 337
Update Counts in Oracle Batching......Page 338
Adding Operations to the Batch......Page 340
Executing the Batch......Page 341
Clearing the Batch......Page 342
Update Counts in the Oracle Implementation of Standard Batching......Page 343
Error Handling in the Oracle Implementation of Standard Batching......Page 344
Premature Batch Flush......Page 345
Additional Oracle Performance Extensions......Page 346
Setting the Oracle Prefetch Value......Page 347
Defining Column Types......Page 349
DatabaseMetaData TABLE_REMARKS Reporting......Page 351
Considerations for getProcedures() and getProcedureColumns() Methods......Page 352
OCI Driver Support for Oracle Advanced Security......Page 353
JDBC Support for Data Encryption and Integrity......Page 354
OCI Driver Support for Encryption and Integrity......Page 355
Thin Driver Support for Encryption and Integrity......Page 356
Setting Encryption and Integrity Parameters in Java......Page 357
Complete example......Page 358
Connecting to the Database through the Applet......Page 361
Using the Oracle Connection Manager......Page 362
Installing and Running the Oracle Connection Manager......Page 363
Using Signed Applets......Page 364
Configuring a Firewall for Applets that use the JDBC Thin Driver......Page 365
Writing a URL to Connect through a Firewall......Page 366
Packaging Applets......Page 367
ARCHIVE......Page 368
Valid SQL-JDBC Datatype Mappings......Page 371
Supported SQL and PL/SQL Datatypes......Page 373
Date Literals......Page 377
Timestamp Literals......Page 378
LIKE Escape Characters......Page 379
SQL92 to SQL Syntax Example......Page 380
IEEE 754 Floating Point Compliance......Page 381
Retaining Bound Values......Page 382
Connecting to the Database with the Server-Side Internal Driver......Page 385
Connecting with the OracleDriver Class defaultConnection() Method......Page 386
Exception-Handling Extensions for the Server-Side Internal Driver......Page 387
Testing JDBC on the Server......Page 388
Loading Class Files into the Server......Page 389
Server-Side Character Set Conversion of oracle.sql.CHAR Data......Page 390
Middle-Tier Authentication Through Proxy Connections......Page 391
JDBC and Multithreading......Page 395
Disabling Auto-Commit Mode......Page 398
Standard and Oracle Update Batching......Page 399
Mapping Between Built-in SQL and Java Types......Page 400
Boolean Parameters in PL/SQL Stored Procedures......Page 401
Using statement.cancel()......Page 402
Oracle Net Tracing to Trap Network Events......Page 403
TRACE_FILE_CLIENT......Page 404
TRACE_FILE_SERVER......Page 405
Transaction Isolation Levels and Access Modes......Page 406
JDBC Messages Sorted by ORA Number......Page 407
JDBC Messages Sorted Alphabetically......Page 411
HeteroRM XA Messages Sorted Alphabetically......Page 415
TTC Messages Sorted by ORA Number......Page 416
TTC Messages Sorted Alphabetically......Page 417
B......Page 419
C......Page 420
E......Page 421
G......Page 422
J......Page 423
N......Page 424
O......Page 425
R......Page 427
S......Page 428
U......Page 430
X......Page 431