cson  Hex Artifact Content

Artifact 653bce655ed909d00ff83e6e1cadd23978f70a29:

Wiki page [cson_cpdo] by stephan 2011-05-09 17:58:44.
0000: 44 20 32 30 31 31 2d 30 35 2d 30 39 54 31 37 3a  D 2011-05-09T17:
0010: 35 38 3a 34 34 2e 35 34 39 0a 4c 20 63 73 6f 6e  58:44.549.L cson
0020: 5f 63 70 64 6f 0a 50 20 32 36 66 65 62 33 62 31  _cpdo.P 26feb3b1
0030: 36 31 32 63 66 33 34 32 30 61 64 65 34 32 61 36  612cf3420ade42a6
0040: 63 37 65 31 38 39 62 36 63 66 34 39 65 35 39 65  c7e189b6cf49e59e
0050: 0a 55 20 73 74 65 70 68 61 6e 0a 57 20 32 30 35  .U stephan.W 205
0060: 39 0a 3c 73 74 72 6f 6e 67 3e 41 43 48 54 55 4e  9.<strong>ACHTUN
0070: 47 3a 20 54 48 49 53 20 50 41 47 45 20 49 53 20  G: THIS PAGE IS 
0080: 4e 4f 57 20 4d 41 49 4e 54 41 49 4e 45 44 20 49  NOW MAINTAINED I
0090: 4e 20 54 48 45 20 4e 45 57 20 57 49 4b 49 3a 3c  N THE NEW WIKI:<
00a0: 2f 73 74 72 6f 6e 67 3e 20 5b 68 74 74 70 3a 2f  /strong> [http:/
00b0: 2f 77 68 69 6b 69 2e 77 61 6e 64 65 72 69 6e 67  /whiki.wandering
00c0: 68 6f 72 73 65 2e 6e 65 74 2f 77 69 6b 69 73 2f  horse.net/wikis/
00d0: 63 73 6f 6e 2f 3f 70 61 67 65 3d 63 73 6f 6e 5f  cson/?page=cson_
00e0: 63 70 64 6f 5d 0a 0a 0a 53 65 65 20 61 6c 73 6f  cpdo]...See also
00f0: 3a 20 5b 63 73 6f 6e 5f 73 71 6c 69 74 65 33 5d  : [cson_sqlite3]
0100: 2c 20 5b 73 65 6c 65 63 74 2d 74 6f 2d 6a 73 6f  , [select-to-jso
0110: 6e 5d 0d 0a 0d 0a 3c 68 31 3e 63 73 6f 6e 5f 63  n]....<h1>cson_c
0120: 70 64 6f 3c 2f 68 31 3e 0d 0a 0d 0a 54 68 65 20  pdo</h1>....The 
0130: 3c 74 74 3e 63 73 6f 6e 5f 63 70 64 6f 3c 2f 74  <tt>cson_cpdo</t
0140: 74 3e 20 66 61 6d 69 6c 79 20 6f 66 20 66 75 6e  t> family of fun
0150: 63 74 69 6f 6e 73 2c 20 64 65 63 6c 61 72 65 64  ctions, declared
0160: 20 69 6e 20 3c 74 74 3e 5b 2f 66 69 6e 66 6f 3f   in <tt>[/finfo?
0170: 6e 61 6d 65 3d 69 6e 63 6c 75 64 65 2f 77 68 2f  name=include/wh/
0180: 63 73 6f 6e 2f 63 73 6f 6e 5f 63 70 64 6f 2e 68  cson/cson_cpdo.h
0190: 7c 63 73 6f 6e 5f 63 70 64 6f 2e 68 5d 3c 2f 74  |cson_cpdo.h]</t
01a0: 74 3e 2c 20 6d 6f 73 74 6c 79 20 77 6f 72 6b 20  t>, mostly work 
01b0: 69 64 65 6e 74 69 63 61 6c 6c 79 20 74 6f 20 74  identically to t
01c0: 68 65 20 5b 63 73 6f 6e 5f 73 71 6c 69 74 65 33  he [cson_sqlite3
01d0: 5d 20 66 61 6d 69 6c 79 20 6f 66 20 66 75 6e 63  ] family of func
01e0: 74 69 6f 6e 73 20 65 78 63 65 70 74 20 74 68 61  tions except tha
01f0: 74 20 74 68 65 79 20 75 73 65 20 5b 68 74 74 70  t they use [http
0200: 3a 2f 2f 66 6f 73 73 69 6c 2e 77 61 6e 64 65 72  ://fossil.wander
0210: 69 6e 67 68 6f 72 73 65 2e 6e 65 74 2f 72 65 70  inghorse.net/rep
0220: 6f 73 2f 63 70 64 6f 2f 7c 63 70 64 6f 5d 20 64  os/cpdo/|cpdo] d
0230: 61 74 61 62 61 73 65 20 63 6f 6e 6e 65 63 74 69  atabase connecti
0240: 6f 6e 73 20 69 6e 73 74 65 61 64 20 6f 66 20 73  ons instead of s
0250: 71 6c 69 74 65 33 20 63 6f 6e 6e 65 63 74 69 6f  qlite3 connectio
0260: 6e 73 2e 20 53 65 65 20 5b 63 73 6f 6e 5f 73 71  ns. See [cson_sq
0270: 6c 69 74 65 33 5d 20 66 6f 72 20 74 68 65 20 64  lite3] for the d
0280: 65 74 61 69 6c 73 20 61 6e 64 20 65 78 61 6d 70  etails and examp
0290: 6c 65 73 20 6f 66 20 74 68 65 20 67 65 6e 65 72  les of the gener
02a0: 61 74 65 64 20 4a 53 4f 4e 20 73 74 72 75 63 74  ated JSON struct
02b0: 75 72 65 2e 20 49 6e 20 61 64 64 69 74 69 6f 6e  ure. In addition
02c0: 2c 20 74 68 65 20 3c 74 74 3e 63 73 6f 6e 5f 63  , the <tt>cson_c
02d0: 70 64 6f 3c 2f 74 74 3e 20 41 50 49 20 68 61 73  pdo</tt> API has
02e0: 20 63 6f 6e 76 65 6e 69 65 6e 63 65 20 72 6f 75   convenience rou
02f0: 74 69 6e 65 73 20 66 6f 72 20 62 69 6e 64 69 6e  tines for bindin
0300: 67 20 4a 53 4f 4e 20 76 61 6c 75 65 73 20 74 6f  g JSON values to
0310: 20 64 62 20 63 6f 6c 75 6d 6e 73 2c 20 70 61 72   db columns, par
0320: 73 69 6e 67 20 74 68 6f 73 65 20 76 61 6c 75 65  sing those value
0330: 73 2c 20 61 6e 64 20 63 6f 6e 76 65 72 74 69 6e  s, and convertin
0340: 67 20 69 6e 64 69 76 69 64 75 61 6c 20 64 62 20  g individual db 
0350: 3c 74 74 3e 53 45 4c 45 43 54 3c 2f 74 74 3e 20  <tt>SELECT</tt> 
0360: 72 6f 77 73 20 74 6f 20 6f 62 6a 65 63 74 73 20  rows to objects 
0370: 6f 72 20 61 72 72 61 79 73 20 6f 66 20 4a 53 4f  or arrays of JSO
0380: 4e 20 76 61 6c 75 65 73 2e 0d 0a 0d 0a 54 68 65  N values.....The
0390: 20 6d 61 63 72 6f 20 3c 74 74 3e 43 50 44 4f 5f   macro <tt>CPDO_
03a0: 45 4e 41 42 4c 45 5f 43 50 44 4f 3c 2f 74 74 3e  ENABLE_CPDO</tt>
03b0: 20 6d 75 73 74 20 62 65 20 73 65 74 20 74 6f 20   must be set to 
03c0: 61 20 74 72 75 65 20 76 61 6c 75 65 20 77 68 65  a true value whe
03d0: 6e 20 74 68 69 73 20 63 6f 64 65 20 28 6f 72 20  n this code (or 
03e0: 74 68 65 20 5b 41 6d 61 6c 67 61 6d 61 74 69 6f  the [Amalgamatio
03f0: 6e 42 75 69 6c 64 7c 61 6d 61 6c 67 61 6d 61 74  nBuild|amalgamat
0400: 69 6f 6e 20 62 75 69 6c 64 5d 29 20 69 73 20 63  ion build]) is c
0410: 6f 6d 70 69 6c 65 64 2c 20 6f 72 20 65 6c 73 65  ompiled, or else
0420: 20 74 68 65 73 65 20 66 75 6e 63 74 69 6f 6e 73   these functions
0430: 20 77 69 6c 6c 20 6e 6f 74 20 62 65 20 69 6e 63   will not be inc
0440: 6c 75 64 65 64 2e 0d 0a 0d 0a 57 68 65 6e 20 75  luded.....When u
0450: 73 69 6e 67 20 74 68 69 73 20 63 6f 64 65 20 66  sing this code f
0460: 72 6f 6d 20 63 6c 69 65 6e 74 20 61 70 70 6c 69  rom client appli
0470: 63 61 74 69 6f 6e 73 2c 20 74 68 65 79 20 6d 61  cations, they ma
0480: 79 20 6e 65 65 64 20 74 6f 20 64 6f 20 74 68 65  y need to do the
0490: 20 66 6f 6c 6c 6f 77 69 6e 67 20 66 72 6f 6d 20   following from 
04a0: 73 6f 6d 65 77 68 65 72 65 20 6e 65 61 72 20 74  somewhere near t
04b0: 68 65 20 73 74 61 72 74 20 6f 66 20 74 68 65 20  he start of the 
04c0: 61 70 70 6c 69 63 61 74 69 6f 6e 20 74 6f 20 72  application to r
04d0: 65 67 69 73 74 65 72 20 74 68 65 20 73 70 65 63  egister the spec
04e0: 69 66 69 63 20 64 61 74 61 62 61 73 65 20 64 72  ific database dr
04f0: 69 76 65 72 73 3a 0d 0a 0d 0a 3c 76 65 72 62 61  ivers:....<verba
0500: 74 69 6d 3e 0d 0a 2f 2f 20 54 68 65 20 66 6f 6c  tim>..// The fol
0510: 6c 6f 77 69 6e 67 20 66 75 6e 63 74 69 6f 6e 73  lowing functions
0520: 20 61 72 65 20 65 78 70 6f 73 65 64 20 76 69 61   are exposed via
0530: 20 65 69 74 68 65 72 20 74 68 65 20 63 70 64 6f   either the cpdo
0540: 20 68 65 61 64 65 72 73 20 6f 72 0d 0a 2f 2f 20   headers or..// 
0550: 74 68 65 20 63 73 6f 6e 20 61 6d 61 6c 67 61 6d  the cson amalgam
0560: 61 74 69 6f 6e 2c 20 64 65 70 65 6e 64 69 6e 67  ation, depending
0570: 20 6f 6e 20 68 6f 77 20 74 68 65 20 62 75 69 6c   on how the buil
0580: 64 20 69 73 20 63 6f 6e 73 74 72 75 63 74 65 64  d is constructed
0590: 2e 0d 0a 23 69 66 20 43 50 44 4f 5f 45 4e 41 42  ...#if CPDO_ENAB
05a0: 4c 45 5f 53 51 4c 49 54 45 33 0d 0a 20 20 20 20  LE_SQLITE3..    
05b0: 63 70 64 6f 5f 64 72 69 76 65 72 5f 73 71 6c 69  cpdo_driver_sqli
05c0: 74 65 33 5f 72 65 67 69 73 74 65 72 28 29 3b 0d  te3_register();.
05d0: 0a 23 65 6e 64 69 66 0d 0a 23 69 66 20 43 50 44  .#endif..#if CPD
05e0: 4f 5f 45 4e 41 42 4c 45 5f 4d 59 53 51 4c 35 0d  O_ENABLE_MYSQL5.
05f0: 0a 20 20 20 20 63 70 64 6f 5f 64 72 69 76 65 72  .    cpdo_driver
0600: 5f 6d 79 73 71 6c 35 5f 72 65 67 69 73 74 65 72  _mysql5_register
0610: 28 29 3b 0d 0a 23 65 6e 64 69 66 0d 0a 3c 2f 76  ();..#endif..</v
0620: 65 72 62 61 74 69 6d 3e 0d 0a 0d 0a 57 69 74 68  erbatim>....With
0630: 6f 75 74 20 74 68 6f 73 65 20 72 65 67 69 73 74  out those regist
0640: 72 61 74 69 6f 6e 73 2c 20 63 70 64 6f 20 77 6f  rations, cpdo wo
0650: 6e 27 74 20 62 65 20 61 62 6c 65 20 74 6f 20 63  n't be able to c
0660: 6f 6e 6e 65 63 74 20 74 6f 20 74 68 65 20 67 69  onnect to the gi
0670: 76 65 6e 20 64 61 74 61 62 61 73 65 20 74 79 70  ven database typ
0680: 65 2e 0d 0a 0d 0a 57 68 65 6e 20 75 73 69 6e 67  e.....When using
0690: 20 5b 63 73 6f 6e 5f 63 67 69 5d 20 77 69 74 68   [cson_cgi] with
06a0: 20 73 65 73 73 69 6f 6e 73 20 73 75 70 70 6f 72   sessions suppor
06b0: 74 2c 20 74 68 69 73 20 43 47 49 20 69 6e 69 74  t, this CGI init
06c0: 69 61 6c 69 7a 61 74 69 6f 6e 20 70 72 6f 63 65  ialization proce
06d0: 73 73 20 64 6f 65 73 20 74 68 69 73 20 66 6f 72  ss does this for
06e0: 20 74 68 65 20 63 6c 69 65 6e 74 20 3c 65 6d 3e   the client <em>
06f0: 6f 6e 6c 79 20 69 66 3c 2f 65 6d 3e 20 73 65 73  only if</em> ses
0700: 73 69 6f 6e 73 20 61 72 65 20 63 6f 6e 66 69 67  sions are config
0710: 75 72 65 64 20 74 6f 20 75 73 65 20 63 70 64 6f  ured to use cpdo
0720: 20 66 6f 72 20 74 68 65 20 62 61 63 6b 2d 65 6e   for the back-en
0730: 64 20 3c 65 6d 3e 61 6e 64 3c 2f 65 6d 3e 20 74  d <em>and</em> t
0740: 68 65 20 5b 63 73 6f 6e 5f 73 65 73 73 69 6f 6e  he [cson_session
0750: 5d 20 62 69 74 73 20 77 65 72 65 20 63 6f 6d 70  ] bits were comp
0760: 69 6c 65 64 20 77 69 74 68 20 74 68 65 20 70 72  iled with the pr
0770: 6f 70 65 72 20 66 6c 61 67 73 20 74 6f 20 65 6e  oper flags to en
0780: 61 62 6c 65 20 65 61 63 68 20 64 61 74 61 62 61  able each databa
0790: 73 65 20 64 72 69 76 65 72 20 28 73 65 65 20 5b  se driver (see [
07a0: 41 6d 61 6c 67 61 6d 61 74 69 6f 6e 42 75 69 6c  AmalgamationBuil
07b0: 64 5d 20 66 6f 72 20 74 68 6f 73 65 20 66 6c 61  d] for those fla
07c0: 67 73 29 2e 0d 0a 0d 0a 53 65 65 20 5b 68 74 74  gs).....See [htt
07d0: 70 3a 2f 2f 66 6f 73 73 69 6c 2e 77 61 6e 64 65  p://fossil.wande
07e0: 72 69 6e 67 68 6f 72 73 65 2e 6e 65 74 2f 72 65  ringhorse.net/re
07f0: 70 6f 73 2f 63 70 64 6f 2f 69 6e 64 65 78 2e 63  pos/cpdo/index.c
0800: 67 69 2f 77 69 6b 69 2f 41 6d 61 6c 67 61 6d 61  gi/wiki/Amalgama
0810: 74 69 6f 6e 42 75 69 6c 64 7c 74 68 65 20 63 70  tionBuild|the cp
0820: 64 6f 20 77 69 6b 69 5d 20 66 6f 72 20 6d 6f 72  do wiki] for mor
0830: 65 20 64 65 74 61 69 6c 73 20 61 62 6f 75 74 20  e details about 
0840: 63 6f 6d 70 69 6c 69 6e 67 20 73 70 65 63 69 66  compiling specif
0850: 69 63 20 64 72 69 76 65 72 20 73 75 70 70 6f 72  ic driver suppor
0860: 74 20 69 6e 74 6f 20 63 70 64 6f 2e 0a 0a 5a 20  t into cpdo...Z 
0870: 38 37 33 65 33 32 34 61 31 64 65 30 36 33 30 38  873e324a1de06308
0880: 31 38 36 37 61 35 38 36 61 31 32 38 62 64 39 32  1867a586a128bd92
0890: 0a                                               .