Oracle C++ Call Interface Programmer's Guide

More documents

Recommendations

Info

1 Introduction to OCCI This chapter provides an overview of Oracle C++ Call Interface (OCCI) and introduces terminology used in discussing OCCI. You are provided with the background information needed to develop C++ applications that run in an Oracle environment. The following topics are covered: ■ Overview of OCCI ■ Processing of SQL Statements ■ Overview of PL/SQL ■ Special OCCI/SQL Terms ■ Object Support Introduction to OCCI 1-1
Page 1 and 2: Oracle® C++ Call Interface Program
Page 3 and 4: List List of Figures Tables Content
Page 5 and 6: Null and Truncated Data............
Page 7 and 8: 6 Metadata Overview of Metadata ...
Page 9 and 10: length() ..........................
Page 11 and 12: flushCache().......................
Page 13 and 14: getSecond() .......................
Page 15 and 16: cos()..............................
Page 17 and 18: operator new().....................
Page 19 and 20: isTruncated() .....................
Page 21 and 22: setCharacterStreamMode() ..........
Page 23 and 24: Index occiinh.typ .................
Page 25 and 26: List of Tables 2-1 Normal Data - No
Page 27 and 28: Oracle C++ Call Interface Programme
Page 29 and 30: Preface The Oracle C++ Call Interfa
Page 31 and 32: Related Documentation Chapter 4, "D
Page 33 and 34: Conventions in Text We use various
Page 35 and 36: Convention Meaning Example UPPERCAS
Page 37 and 38: What’s New in Orace C++ Call Inte
Page 39: ■ Number Class ■ operator signe
Page 44 and 45: Overview of OCCI Overview of OCCI B
Page 46 and 47: Overview of OCCI Functionality of O
Page 48 and 49: Processing of SQL Statements Contro
Page 50 and 51: Special OCCI/SQL Terms BEGIN GET_EM
Page 52 and 53: Object Support Multiple application
Page 54 and 55: Object Support ■ Facilitating sch
Page 56 and 57: Connecting to a Database Connecting
Page 58 and 59: Connecting to a Database duration.
Page 60 and 61: Executing SQL DDL and DML Statement
Page 62 and 63: Types of SQL Statements in the OCCI
Page 68 and 69: Executing SQL Queries Result Set Ex
Page 70 and 71: Executing Statements Dynamically To
Page 72 and 73: Executing Statements Dynamically VA
Page 74 and 75: Error Handling Committing a Transac
Page 76 and 77: Error Handling The default behavior
Page 78 and 79: Advanced Relational Techniques proc
Page 80 and 81: Advanced Relational Techniques Appl
Page 82 and 83: Advanced Relational Techniques ■
Page 84 and 85: Advanced Relational Techniques Howe
Page 86 and 87: Working with Objects in OCCI Overvi
Page 88 and 89: Working with Objects in OCCI Transi
Page 90 and 91: Representing Objects in C++ Applica
Page 92 and 93:
Developing an OCCI Object Applicati
Page 94 and 95:
Page 96 and 97:
Page 98 and 99:
Overview of Navigational Access Res
Page 100 and 101:
Overview of Navigational Access and
Page 102 and 103:
Overview of Navigational Access Gar
Page 104 and 105:
Overview of Complex Object Retrieva
Page 106 and 107:
Working with Collections Prefetchin
Page 108 and 109:
Using Object References Nullness WH
Page 110 and 111:
Type Inheritance Substitutability A
Page 112 and 113:
Type Inheritance A subtype of NOT I
Page 114 and 115:
A Sample OCCI Application } // decl
Page 116 and 117:
A Sample OCCI Application // this n
Page 118 and 119:
A Sample OCCI Application 3-34 Orac
Page 120 and 121:
Overview of Oracle Datatypes Overvi
Page 122 and 123:
Internal Datatypes Character String
Page 124 and 125:
External Datatypes Table 4-2 Extern
Page 126 and 127:
External Datatypes Please note the
Page 128 and 129:
External Datatypes For byte 1, 119
Page 130 and 131:
External Datatypes specify an inter
Page 132 and 133:
External Datatypes Oracle stores va
Page 134 and 135:
External Datatypes OCCI POBJECT OCC
Page 136 and 137:
External Datatypes TIMESTAMP ’199
Page 138 and 139:
Data Conversions Data Conversions V
Page 140 and 141:
Data Conversions Table 4-5 Data Con
Page 142 and 143:
Data Conversions Data Conversions f
Page 144 and 145:
Overview of LOBs Overview of LOBs O
Page 146 and 147:
LOB Classes and Methods Inline Stor
Page 148 and 149:
LOB Classes and Methods Table 5-1 O
Page 150 and 151:
LOB Classes and Methods ■ Blob Op
Page 152 and 153:
LOB Classes and Methods Reading and
Page 154 and 155:
LOB Classes and Methods } if(bfile.
Page 156 and 157:
LOB Classes and Methods blob.closeS
Page 158 and 159:
Objects with LOB Attributes conn->c
Page 160 and 161:
Objects with LOB Attributes applica
Page 162 and 163:
Overview of Metadata Overview of Me
Page 164 and 165:
Describing Database Metadata For ex
Page 166 and 167:
Describing Database Metadata unsign
Page 168 and 169:
Describing Database Metadata MetaDa
Page 170 and 171:
Attribute Reference Parameter Attri
Page 172 and 173:
Attribute Reference The additional
Page 174 and 175:
Attribute Reference Table 6-8 Attri
Page 176 and 177:
Attribute Reference Type Method Att
Page 178 and 179:
Attribute Reference Table 6-11 Attr
Page 180 and 181:
Attribute Reference Column Attribut
Page 182 and 183:
Attribute Reference Table 6-15 Attr
Page 184 and 185:
Attribute Reference Schema Attribut
Page 186 and 187:
Attribute Reference 6-26 Oracle C++
Page 188 and 189:
How to Use the OTT Utility Overview
Page 190 and 191:
How to Use the OTT Utility In this
Page 192 and 193:
How to Use the OTT Utility ■ Cont
Page 194 and 195:
How to Use the OTT Utility { if (st
Page 196 and 197:
Invoking the OTT Utility TYPE SCOTT
Page 198 and 199:
Invoking the OTT Utility Invoking t
Page 200 and 201:
Overview of the INTYPE File hfile P
Page 202 and 203:
OTT Utility Datatype Mappings Use q
Page 204 and 205:
OTT Utility Datatype Mappings Table
Page 206 and 207:
OTT Utility Datatype Mappings Table
Page 208 and 209:
OTT Utility Datatype Mappings OCIIn
Page 210 and 211:
OTT Utility Datatype Mappings #ifnd
Page 212 and 213:
Overview of the OUTTYPE File OCCI_S
Page 214 and 215:
The OTT Utility and OCCI Applicatio
Page 216 and 217:
Page 218 and 219:
Page 220 and 221:
Page 222 and 223:
Page 224 and 225:
Page 226 and 227:
Page 228 and 229:
Page 230 and 231:
Page 232 and 233:
Page 234 and 235:
Page 236 and 237:
Page 238 and 239:
Page 240 and 241:
Page 242 and 243:
Page 244 and 245:
Page 246 and 247:
Page 248 and 249:
Carrying Forward User Added Code vo
Page 250 and 251:
Carrying Forward User Added Code 5.
Page 252 and 253:
Carrying Forward User Added Code cl
Page 254 and 255:
Carrying Forward User Added Code Co
Page 256 and 257:
Carrying Forward User Added Code //
Page 258 and 259:
Carrying Forward User Added Code };
Page 260 and 261:
Carrying Forward User Added Code #e
Page 262 and 263:
Carrying Forward User Added Code {
Page 264 and 265:
Carrying Forward User Added Code tr
Page 266 and 267:
Carrying Forward User Added Code ob
Page 268 and 269:
Carrying Forward User Added Code my
Page 270 and 271:
Carrying Forward User Added Code }
Page 272 and 273:
Example OCCI Application TYPE PERSO
Page 274 and 275:
Example OCCI Application }; void se
Page 276 and 277:
Example OCCI Application #ifndef MY
Page 278 and 279:
Example OCCI Application private: O
Page 280 and 281:
Example OCCI Application oracle::oc
Page 282 and 283:
Example OCCI Application } (char *)
Page 284 and 285:
Example OCCI Application void CPers
Page 286 and 287:
Example OCCI Application try { if (
Page 288 and 289:
Example OCCI Application } void CSt
Page 290 and 291:
Example OCCI Application Example of
Page 292 and 293:
Example OCCI Application using name
Page 294 and 295:
Example OCCI Application { cout
Page 296 and 297:
Example OCCI Application { setId(id
Page 298 and 299:
Example OCCI Application joe->displ
Page 300 and 301:
Example OCCI Application } delete a
Page 302 and 303:
OTT Utility Reference OTT Utility R
Page 304 and 305:
OTT Utility Reference OTT Utility P
Page 306 and 307:
OTT Utility Reference If CASE=OPPOS
Page 308 and 309:
OTT Utility Reference If the filena
Page 310 and 311:
OTT Utility Reference MAPFUNC Param
Page 312 and 313:
OTT Utility Reference OTT username/
Page 314 and 315:
OTT Utility Reference [TRANSLATE{me
Page 316 and 317:
OTT Utility Reference The OTT utili
Page 318 and 319:
OTT Utility Reference The schema na
Page 320 and 321:
OTT Utility Reference Default Name
Page 322 and 323:
OTT Utility Reference though, it co
Page 325 and 326:
8 OCCI Classes and Methods This cha
Page 327 and 328:
Table 8-1 OCCI Classes (Cont.) Clas
Page 329 and 330:
Bfile Class Bfile Class The Bfile c
Page 331 and 332:
fileExists() getDirAlias() getFileN
Page 333 and 334:
length() open() operator=() operato
Page 335 and 336:
setName() setNull() buffer The buff
Page 337 and 338:
append() Table 8-3 Blob Methods (Co
Page 339 and 340:
getChunkSize() Parameters srcBfile
Page 341 and 342:
isOpen() length() open() operator=(
Page 343 and 344:
setEmpty() setEmpty() Syntax unsign
Page 345 and 346:
writeChunk() unsigned int bufsize,
Page 347 and 348:
Bytes Class Bytes Class Methods of
Page 349 and 350:
length() setNull() This method retu
Page 351 and 352:
Table 8-5 Clob Methods (Cont.) Meth
Page 353 and 354:
getCharSetForm() unsigned int dstOf
Page 355 and 356:
isInitialized() isNull() isOpen() l
Page 357 and 358:
operator!=() read() Parameters srcC
Page 359 and 360:
setEmpty() setEmpty() setNull() tri
Page 361 and 362:
writeChunk() Clob Class This method
Page 363 and 364:
changePassword() commit() This meth
Page 365 and 366:
getOCIServer() Connection Class prm
Page 367 and 368:
ConnectionPool Class ConnectionPool
Page 369 and 370:
Parameters getBusyConnections() get
Page 371 and 372:
setPoolSize() setTimeOut() Connecti
Page 373 and 374:
Date Class Date Class The Date clas
Page 375 and 376:
Table 8-8 Date Methods (Cont.) Meth
Page 377 and 378:
fromBytes() fromText() This method
Page 379 and 380:
isNull() lastDay() nextDay() operat
Page 381 and 382:
operator>=() operator(const Date &a
Page 383 and 384:
setNull() toBytes() toText() day Th
Page 385 and 386:
Parameters zone1 A string represent
Page 387 and 388:
createConnection() This method esta
Page 389 and 390:
Environment Class method. If no mem
Page 391 and 392:
setCacheMaxSize() setCacheOptSize()
Page 393 and 394:
IntervalDS Class IntervalDS Class L
Page 395 and 396:
Summary of IntervalDS Methods Table
Page 397 and 398:
getHour() getMinute() getSecond() i
Page 399 and 400:
operator!=() operator/() const Inte
Page 401 and 402:
operator
Page 403 and 404:
set() setNull() Parameters a A day
Page 405 and 406:
IntervalYM Class IntervalYM Class I
Page 407 and 408:
fromText() Table 8-11 IntervalYM Me
Page 409 and 410:
operator*=() operator=() operator==
Page 411 and 412:
operator/=() operator>() operator>=
Page 413 and 414:
operator-=() operator+() operator+=
Page 415 and 416:
nlsParam This parameter is not curr
Page 417 and 418:
Syntax Map Class registration can b
Page 419 and 420:
■ TYPEENCAP_PRIVATE ■ TYPEENCAP
Page 421 and 422:
getAttributeType() getBoolean() get
Page 423 and 424:
getString() getTimeStamp() getUInt(
Page 425 and 426:
Number Class Number Class The Numbe
Page 427 and 428:
* Create a statement and associate
Page 429 and 430:
Table 8-14 Number Methods (Cont.) M
Page 431 and 432:
abs() arcCos() arcSin() arcTan() Ta
Page 433 and 434:
floor() fromBytes() fromText() Numb
Page 435 and 436:
isNull() ln() log() operator++() Pa
Page 437 and 438:
operator/() operator%() operator+()
Page 439 and 440:
operator() Parameters a, b Numbers
Page 441 and 442:
operator=() operator*=() operator/=
Page 443 and 444:
operator char() Parameters operator
Page 445 and 446:
operator unsigned long() operator u
Page 447 and 448:
sign() sin() sqareroot() tan() toBy
Page 449 and 450:
Parameters Number Class decplace Th
Page 451 and 452:
flush() getConnection() getRef() Ta
Page 453 and 454:
markDelete() markModified() operato
Page 455 and 456:
setNull() unmark() unpin() This met
Page 457 and 458:
clear() getConnection() getRef() Ta
Page 459 and 460:
operator*() operator==() operator!=
Page 461 and 462:
setPrefetch() setLock() Ref Class S
Page 463 and 464:
RefAny Class RefAny Class The RefAn
Page 465 and 466:
operator==() operator!=() unmarkDel
Page 467 and 468:
Summary of ResultSet Methods Table
Page 469 and 470:
cancel() closeStream() Table 8-18 R
Page 471 and 472:
getCharSet() getClob() Parameters c
Page 473 and 474:
getDate() Parameters colIndex The f
Page 475 and 476:
getIntervalYM() Parameters colIndex
Page 477 and 478:
getRowid() getRowPosition() getStat
Page 479 and 480:
getVector() ResultSet Class This me
Page 481 and 482:
getVectorOfRefs() ResultSet Class I
Page 483 and 484:
next() ResultSet Class A ResultSet
Page 485 and 486:
setCharSet() ResultSet Class Overri
Page 487 and 488:
setErrorOnNull() ind Pointer to an
Page 489 and 490:
SQLException Class SQLException() S
Page 491 and 492:
Statement Class Statement Class A S
Page 493 and 494:
Table 8-20 Statement Methods (Cont.
Page 495 and 496:
addIteration() closeResultSet() Tab
Page 497 and 498:
Statement Class If UPDATE_COUNT_AVA
Page 499 and 500:
executeQuery() executeUpdate() getA
Page 501 and 502:
getCharSet() getClob() getConnectio
Page 503 and 504:
getDatabaseNCHARParam() getDate() g
Page 505 and 506:
getIntervalYM() getMaxIterations()
Page 507 and 508:
getResultSet() getRowid() getSQL()
Page 509 and 510:
getUpdateCount() getVector() Parame
Page 511 and 512:
getVectorOfRefs() unsigned int para
Page 513 and 514:
Parameters preTruncationLength() pa
Page 515 and 516:
Parameters paramIndex The first par
Page 517 and 518:
setCharSet() setClob() setDate() St
Page 519 and 520:
Statement Class Note that not all t
Page 521 and 522:
ub4 *arrayLength, sb4 elementSize,
Page 523 and 524:
setFloat() setInt() Syntax void set
Page 525 and 526:
Statement Class larger the iteratio
Page 527 and 528:
Parameters setPrefetchMemorySize()
Page 529 and 530:
setString() setTimestamp() Syntax v
Page 531 and 532:
void setVector(Statement *stmt, uns
Page 533 and 534:
setVectorOfRefs() Parameters stmt s
Page 535 and 536:
Stream Class You use a Stream to re
Page 537 and 538:
writeLastBuffer() status() Paramete
Page 539 and 540:
Timestamp Class The following code
Page 541 and 542:
fromText() Table 8-22 Timestamp Met
Page 543 and 544:
getTimeZoneOffset() intervalAdd() s
Page 545 and 546:
operator==() operator!=() operator>
Page 547 and 548:
operator
Page 549 and 550:
subDS() subYM() Syntax void setTime
Page 551:
This part contains one appendix:
Page 554 and 555:
OCCI Demonstration Programs OCCI De
Page 556 and 557:
OCCI Demonstration Programs # make
Page 558 and 559:
OCCI Demonstration Programs A-6 Ora
Page 560 and 561:
OCCI Demonstration Programs buildcp
Page 562 and 563:
OCCI Demonstration Programs string
Page 564 and 565:
OCCI Demonstration Programs passwor
Page 566 and 567:
OCCI Demonstration Programs * The d
Page 568 and 569:
OCCI Demonstration Programs } * def
Page 570 and 571:
OCCI Demonstration Programs occicol
Page 572 and 573:
OCCI Demonstration Programs } "INSE
Page 574 and 575:
OCCI Demonstration Programs try{ if
Page 576 and 577:
OCCI Demonstration Programs conn =
Page 578 and 579:
OCCI Demonstration Programs cout
Page 580 and 581:
OCCI Demonstration Programs { MetaD
Page 582 and 583:
OCCI Demonstration Programs md.getI
Page 584 and 585:
OCCI Demonstration Programs occidml
Page 586 and 587:
OCCI Demonstration Programs "UPDATE
Page 588 and 589:
OCCI Demonstration Programs occiinh
Page 590 and 591:
OCCI Demonstration Programs occiinh
Page 592 and 593:
OCCI Demonstration Programs stmt->s
Page 594 and 595:
OCCI Demonstration Programs occiobj
Page 596 and 597:
OCCI Demonstration Programs */ void
Page 598 and 599:
OCCI Demonstration Programs try{ st
Page 600 and 601:
OCCI Demonstration Programs class a
Page 602 and 603:
OCCI Demonstration Programs /** * d
Page 604 and 605:
OCCI Demonstration Programs occipoo
Page 606 and 607:
OCCI Demonstration Programs occipro
Page 608 and 609:
OCCI Demonstration Programs string
Page 610 and 611:
OCCI Demonstration Programs { env->
Page 612 and 613:
OCCI Demonstration Programs A-60 Or
Page 614 and 615:
complex object retrieval complex ob
Page 616 and 617:
opening, 5-8 overview, 5-2 reading,
Page 618 and 619:
connection pool, 2-3 creating, 2-2
Page 620:
external datatype, 4-19 VARNUM exte
show all

Oracle C++ Call Interface Programmer's Guide

Create successful ePaper yourself

Delete template?

Save as template?