/ Hex Artifact Content
Login

Artifact e72016998c9a22d439ddfd547b69e1ebac810c24:


0000: 0a 23 69 66 20 21 64 65 66 69 6e 65 64 28 53 51  .#if !defined(SQ
0010: 4c 49 54 45 43 48 41 4e 47 45 42 41 54 43 48 5f  LITECHANGEBATCH_
0020: 48 5f 29 20 0a 23 64 65 66 69 6e 65 20 53 51 4c  H_) .#define SQL
0030: 49 54 45 43 48 41 4e 47 45 42 41 54 43 48 5f 48  ITECHANGEBATCH_H
0040: 5f 20 31 0a 0a 74 79 70 65 64 65 66 20 73 74 72  _ 1..typedef str
0050: 75 63 74 20 73 71 6c 69 74 65 33 5f 63 68 61 6e  uct sqlite3_chan
0060: 67 65 62 61 74 63 68 20 73 71 6c 69 74 65 33 5f  gebatch sqlite3_
0070: 63 68 61 6e 67 65 62 61 74 63 68 3b 0a 0a 2f 2a  changebatch;../*
0080: 0a 2a 2a 20 43 72 65 61 74 65 20 61 20 6e 65 77  .** Create a new
0090: 20 63 68 61 6e 67 65 62 61 74 63 68 20 6f 62 6a   changebatch obj
00a0: 65 63 74 20 66 6f 72 20 64 65 74 65 63 74 69 6e  ect for detectin
00b0: 67 20 63 6f 6e 66 6c 69 63 74 73 20 62 65 74 77  g conflicts betw
00c0: 65 65 6e 0a 2a 2a 20 63 68 61 6e 67 65 73 65 74  een.** changeset
00d0: 73 20 61 73 73 6f 63 69 61 74 65 64 20 77 69 74  s associated wit
00e0: 68 20 61 20 73 63 68 65 6d 61 20 65 71 75 69 76  h a schema equiv
00f0: 61 6c 65 6e 74 20 74 6f 20 74 68 61 74 20 6f 66  alent to that of
0100: 20 74 68 65 20 22 6d 61 69 6e 22 0a 2a 2a 20 64   the "main".** d
0110: 61 74 61 62 61 73 65 20 6f 66 20 74 68 65 20 6f  atabase of the o
0120: 70 65 6e 20 64 61 74 61 62 61 73 65 20 68 61 6e  pen database han
0130: 64 6c 65 20 64 62 20 70 61 73 73 65 64 20 61 73  dle db passed as
0140: 20 74 68 65 20 66 69 72 73 74 0a 2a 2a 20 70 61   the first.** pa
0150: 72 61 6d 65 74 65 72 2e 20 49 74 20 69 73 20 74  rameter. It is t
0160: 68 65 20 72 65 73 70 6f 6e 73 69 62 69 6c 69 74  he responsibilit
0170: 79 20 6f 66 20 74 68 65 20 63 61 6c 6c 65 72 20  y of the caller 
0180: 74 6f 20 65 6e 73 75 72 65 20 74 68 61 74 0a 2a  to ensure that.*
0190: 2a 20 74 68 65 20 64 61 74 61 62 61 73 65 20 68  * the database h
01a0: 61 6e 64 6c 65 20 69 73 20 6e 6f 74 20 63 6c 6f  andle is not clo
01b0: 73 65 64 20 75 6e 74 69 6c 20 61 66 74 65 72 20  sed until after 
01c0: 74 68 65 20 63 68 61 6e 67 65 62 61 74 63 68 0a  the changebatch.
01d0: 2a 2a 20 6f 62 6a 65 63 74 20 68 61 73 20 62 65  ** object has be
01e0: 65 6e 20 64 65 6c 65 74 65 64 2e 0a 2a 2a 0a 2a  en deleted..**.*
01f0: 2a 20 41 20 63 68 61 6e 67 65 62 61 74 63 68 20  * A changebatch 
0200: 6f 62 6a 65 63 74 20 69 73 20 75 73 65 64 20 74  object is used t
0210: 6f 20 64 65 74 65 63 74 20 62 61 74 63 68 65 73  o detect batches
0220: 20 6f 66 20 6e 6f 6e 2d 63 6f 6e 66 6c 69 63 74   of non-conflict
0230: 69 6e 67 0a 2a 2a 20 63 68 61 6e 67 65 73 65 74  ing.** changeset
0240: 73 2e 20 43 68 61 6e 67 65 73 65 74 73 20 74 68  s. Changesets th
0250: 61 74 20 64 6f 20 6e 6f 74 20 63 6f 6e 66 6c 69  at do not confli
0260: 63 74 20 6d 61 79 20 62 65 20 61 70 70 6c 69 65  ct may be applie
0270: 64 20 74 6f 20 74 68 65 20 0a 2a 2a 20 74 61 72  d to the .** tar
0280: 67 65 74 20 64 61 74 61 62 61 73 65 20 69 6e 20  get database in 
0290: 61 6e 79 20 6f 72 64 65 72 20 77 69 74 68 6f 75  any order withou
02a0: 74 20 61 66 66 65 63 74 69 6e 67 20 74 68 65 20  t affecting the 
02b0: 66 69 6e 61 6c 20 73 74 61 74 65 20 6f 66 20 0a  final state of .
02c0: 2a 2a 20 74 68 65 20 64 61 74 61 62 61 73 65 2e  ** the database.
02d0: 0a 2a 2a 0a 2a 2a 20 54 68 65 20 63 68 61 6e 67  .**.** The chang
02e0: 65 62 61 74 63 68 20 6f 62 6a 65 63 74 20 6f 6e  ebatch object on
02f0: 6c 79 20 77 6f 72 6b 73 20 72 65 6c 69 61 62 6c  ly works reliabl
0300: 79 20 69 66 20 50 52 49 4d 41 52 59 20 4b 45 59  y if PRIMARY KEY
0310: 20 61 6e 64 20 55 4e 49 51 55 45 0a 2a 2a 20 63   and UNIQUE.** c
0320: 6f 6e 73 74 72 61 69 6e 74 73 20 6f 6e 20 74 61  onstraints on ta
0330: 62 6c 65 73 20 61 66 66 65 63 74 65 64 20 62 79  bles affected by
0340: 20 74 68 65 20 63 68 61 6e 67 65 73 65 74 73 20   the changesets 
0350: 75 73 65 20 63 6f 6c 6c 61 74 69 6f 6e 0a 2a 2a  use collation.**
0360: 20 73 65 71 75 65 6e 63 65 73 20 74 68 61 74 20   sequences that 
0370: 61 72 65 20 65 71 75 69 76 61 6c 65 6e 74 20 74  are equivalent t
0380: 6f 20 62 75 69 6c 74 2d 69 6e 20 63 6f 6c 6c 61  o built-in colla
0390: 74 69 6f 6e 20 73 65 71 75 65 6e 63 65 20 0a 2a  tion sequence .*
03a0: 2a 20 42 49 4e 41 52 59 20 66 6f 72 20 74 68 65  * BINARY for the
03b0: 20 3d 3d 20 6f 70 65 72 61 74 69 6f 6e 2e 0a 2a   == operation..*
03c0: 2a 0a 2a 2a 20 49 66 20 73 75 63 63 65 73 73 66  *.** If successf
03d0: 75 6c 2c 20 53 51 4c 49 54 45 5f 4f 4b 20 69 73  ul, SQLITE_OK is
03e0: 20 72 65 74 75 72 6e 65 64 20 61 6e 64 20 28 2a   returned and (*
03f0: 70 70 29 20 73 65 74 20 74 6f 20 70 6f 69 6e 74  pp) set to point
0400: 20 74 6f 0a 2a 2a 20 74 68 65 20 6e 65 77 20 63   to.** the new c
0410: 68 61 6e 67 65 62 61 74 63 68 20 6f 62 6a 65 63  hangebatch objec
0420: 74 2e 20 49 66 20 61 6e 20 65 72 72 6f 72 20 6f  t. If an error o
0430: 63 63 75 72 73 2c 20 61 6e 20 53 51 4c 69 74 65  ccurs, an SQLite
0440: 20 65 72 72 6f 72 0a 2a 2a 20 63 6f 64 65 20 69   error.** code i
0450: 73 20 72 65 74 75 72 6e 65 64 20 61 6e 64 20 74  s returned and t
0460: 68 65 20 66 69 6e 61 6c 20 76 61 6c 75 65 20 6f  he final value o
0470: 66 20 28 2a 70 70 29 20 69 73 20 75 6e 64 65 66  f (*pp) is undef
0480: 69 6e 65 64 2e 0a 2a 2f 0a 69 6e 74 20 73 71 6c  ined..*/.int sql
0490: 69 74 65 33 63 68 61 6e 67 65 62 61 74 63 68 5f  ite3changebatch_
04a0: 6e 65 77 28 73 71 6c 69 74 65 33 20 2a 64 62 2c  new(sqlite3 *db,
04b0: 20 73 71 6c 69 74 65 33 5f 63 68 61 6e 67 65 62   sqlite3_changeb
04c0: 61 74 63 68 20 2a 2a 70 70 29 3b 0a 0a 2f 2a 0a  atch **pp);../*.
04d0: 2a 2a 20 41 72 67 75 6d 65 6e 74 20 70 20 70 6f  ** Argument p po
04e0: 69 6e 74 73 20 74 6f 20 61 20 62 75 66 66 65 72  ints to a buffer
04f0: 20 63 6f 6e 74 61 69 6e 69 6e 67 20 61 20 63 68   containing a ch
0500: 61 6e 67 65 73 65 74 20 6e 20 62 79 74 65 73 20  angeset n bytes 
0510: 69 6e 0a 2a 2a 20 73 69 7a 65 2e 20 41 73 73 75  in.** size. Assu
0520: 6d 69 6e 67 20 6e 6f 20 65 72 72 6f 72 20 6f 63  ming no error oc
0530: 63 75 72 73 2c 20 74 68 69 73 20 66 75 6e 63 74  curs, this funct
0540: 69 6f 6e 20 72 65 74 75 72 6e 73 20 53 51 4c 49  ion returns SQLI
0550: 54 45 5f 4f 4b 0a 2a 2a 20 69 66 20 74 68 65 20  TE_OK.** if the 
0560: 63 68 61 6e 67 65 73 65 74 20 64 6f 65 73 20 6e  changeset does n
0570: 6f 74 20 63 6f 6e 66 6c 69 63 74 20 77 69 74 68  ot conflict with
0580: 20 61 6e 79 20 63 68 61 6e 67 65 73 65 74 20 70   any changeset p
0590: 61 73 73 65 64 20 0a 2a 2a 20 74 6f 20 61 6e 20  assed .** to an 
05a0: 73 71 6c 69 74 65 33 63 68 61 6e 67 65 62 61 74  sqlite3changebat
05b0: 63 68 5f 61 64 64 28 29 20 63 61 6c 6c 20 6d 61  ch_add() call ma
05c0: 64 65 20 6f 6e 20 74 68 65 20 73 61 6d 65 20 0a  de on the same .
05d0: 2a 2a 20 73 71 6c 69 74 65 33 5f 63 68 61 6e 67  ** sqlite3_chang
05e0: 65 62 61 74 63 68 2a 20 68 61 6e 64 6c 65 20 73  ebatch* handle s
05f0: 69 6e 63 65 20 74 68 65 20 6d 6f 73 74 20 72 65  ince the most re
0600: 63 65 6e 74 20 63 61 6c 6c 20 74 6f 0a 2a 2a 20  cent call to.** 
0610: 73 71 6c 69 74 65 33 63 68 61 6e 67 65 62 61 74  sqlite3changebat
0620: 63 68 5f 7a 65 72 6f 28 29 2e 20 49 66 20 74 68  ch_zero(). If th
0630: 65 20 63 68 61 6e 67 65 73 65 74 20 64 6f 65 73  e changeset does
0640: 20 63 6f 6e 66 6c 69 63 74 20 77 69 74 68 20 0a   conflict with .
0650: 2a 2a 20 61 6e 20 65 61 72 6c 69 65 72 20 73 75  ** an earlier su
0660: 63 68 20 63 68 61 6e 67 65 73 65 74 2c 20 53 51  ch changeset, SQ
0670: 4c 49 54 45 5f 43 4f 4e 53 54 52 41 49 4e 54 20  LITE_CONSTRAINT 
0680: 69 73 20 72 65 74 75 72 6e 65 64 2e 20 4f 72 2c  is returned. Or,
0690: 20 0a 2a 2a 20 69 66 20 61 6e 20 65 72 72 6f 72   .** if an error
06a0: 20 6f 63 63 75 72 73 2c 20 73 6f 6d 65 20 6f 74   occurs, some ot
06b0: 68 65 72 20 53 51 4c 69 74 65 20 65 72 72 6f 72  her SQLite error
06c0: 20 63 6f 64 65 20 6d 61 79 20 62 65 20 72 65 74   code may be ret
06d0: 75 72 6e 65 64 2e 0a 2a 2a 0a 2a 2a 20 4f 6e 65  urned..**.** One
06e0: 20 63 68 61 6e 67 65 73 65 74 20 69 73 20 73 61   changeset is sa
06f0: 69 64 20 74 6f 20 63 6f 6e 66 6c 69 63 74 20 77  id to conflict w
0700: 69 74 68 20 61 6e 6f 74 68 65 72 20 69 66 0a 2a  ith another if.*
0710: 2a 20 65 69 74 68 65 72 3a 0a 2a 2a 0a 2a 2a 20  * either:.**.** 
0720: 20 20 2a 20 74 68 65 20 74 77 6f 20 63 68 61 6e    * the two chan
0730: 67 65 73 65 74 73 20 63 6f 6e 74 61 69 6e 20 6f  gesets contain o
0740: 70 65 72 61 74 69 6f 6e 73 20 28 49 4e 53 45 52  perations (INSER
0750: 54 2c 20 55 50 44 41 54 45 20 6f 72 20 0a 2a 2a  T, UPDATE or .**
0760: 20 20 20 20 20 44 45 4c 45 54 45 29 20 6f 6e 20       DELETE) on 
0770: 74 68 65 20 73 61 6d 65 20 72 6f 77 2c 20 69 64  the same row, id
0780: 65 6e 74 69 66 69 65 64 20 62 79 20 70 72 69 6d  entified by prim
0790: 61 72 79 20 6b 65 79 2c 20 6f 72 0a 2a 2a 0a 2a  ary key, or.**.*
07a0: 2a 20 20 20 2a 20 74 68 65 20 74 77 6f 20 63 68  *   * the two ch
07b0: 61 6e 67 65 73 65 74 73 20 63 6f 6e 74 61 69 6e  angesets contain
07c0: 20 6f 70 65 72 61 74 69 6f 6e 73 20 28 49 4e 53   operations (INS
07d0: 45 52 54 2c 20 55 50 44 41 54 45 20 6f 72 20 0a  ERT, UPDATE or .
07e0: 2a 2a 20 20 20 20 20 44 45 4c 45 54 45 29 20 6f  **     DELETE) o
07f0: 6e 20 72 6f 77 73 20 77 69 74 68 20 69 64 65 6e  n rows with iden
0800: 74 69 63 61 6c 20 76 61 6c 75 65 73 20 69 6e 20  tical values in 
0810: 61 6e 79 20 63 6f 6d 62 69 6e 61 74 69 6f 6e 20  any combination 
0820: 0a 2a 2a 20 20 20 20 20 6f 66 20 66 69 65 6c 64  .**     of field
0830: 73 20 63 6f 6e 73 74 72 61 69 6e 65 64 20 62 79  s constrained by
0840: 20 61 20 55 4e 49 51 55 45 20 63 6f 6e 73 74 72   a UNIQUE constr
0850: 61 69 6e 74 2e 0a 2a 2a 0a 2a 2a 20 45 76 65 6e  aint..**.** Even
0860: 20 69 66 20 74 68 69 73 20 66 75 6e 63 74 69 6f   if this functio
0870: 6e 20 72 65 74 75 72 6e 73 20 53 51 4c 49 54 45  n returns SQLITE
0880: 5f 43 4f 4e 46 4c 49 43 54 2c 20 74 68 65 20 63  _CONFLICT, the c
0890: 75 72 72 65 6e 74 0a 2a 2a 20 63 68 61 6e 67 65  urrent.** change
08a0: 73 65 74 20 69 73 20 61 64 64 65 64 20 74 6f 20  set is added to 
08b0: 74 68 65 20 69 6e 74 65 72 6e 61 6c 20 64 61 74  the internal dat
08c0: 61 20 73 74 72 75 63 74 75 72 65 73 20 2d 20 73  a structures - s
08d0: 6f 20 66 75 74 75 72 65 0a 2a 2a 20 63 61 6c 6c  o future.** call
08e0: 73 20 74 6f 20 74 68 69 73 20 66 75 6e 63 74 69  s to this functi
08f0: 6f 6e 20 6d 61 79 20 63 6f 6e 66 6c 69 63 74 20  on may conflict 
0900: 77 69 74 68 20 69 74 2e 20 49 66 20 74 68 69 73  with it. If this
0910: 20 66 75 6e 63 74 69 6f 6e 0a 2a 2a 20 72 65 74   function.** ret
0920: 75 72 6e 73 20 61 6e 79 20 72 65 73 75 6c 74 20  urns any result 
0930: 63 6f 64 65 20 6f 74 68 65 72 20 74 68 61 6e 20  code other than 
0940: 53 51 4c 49 54 45 5f 4f 4b 20 6f 72 20 53 51 4c  SQLITE_OK or SQL
0950: 49 54 45 5f 43 4f 4e 46 4c 49 43 54 2c 0a 2a 2a  ITE_CONFLICT,.**
0960: 20 74 68 65 20 72 65 73 75 6c 74 20 6f 66 20 61   the result of a
0970: 6e 79 20 66 75 74 75 72 65 20 63 61 6c 6c 20 74  ny future call t
0980: 6f 20 73 71 6c 69 74 65 33 63 68 61 6e 67 65 62  o sqlite3changeb
0990: 61 74 63 68 5f 61 64 64 28 29 20 69 73 0a 2a 2a  atch_add() is.**
09a0: 20 75 6e 64 65 66 69 6e 65 64 2e 0a 2a 2a 0a 2a   undefined..**.*
09b0: 2a 20 4f 6e 6c 79 20 63 68 61 6e 67 65 73 65 74  * Only changeset
09c0: 73 20 6d 61 79 20 62 65 20 70 61 73 73 65 64 20  s may be passed 
09d0: 74 6f 20 74 68 69 73 20 66 75 6e 63 74 69 6f 6e  to this function
09e0: 2e 20 50 61 73 73 69 6e 67 20 61 20 0a 2a 2a 20  . Passing a .** 
09f0: 70 61 74 63 68 73 65 74 20 74 6f 20 74 68 69 73  patchset to this
0a00: 20 66 75 6e 63 74 69 6f 6e 20 72 65 73 75 6c 74   function result
0a10: 73 20 69 6e 20 61 6e 20 53 51 4c 49 54 45 5f 4d  s in an SQLITE_M
0a20: 49 53 55 53 45 20 65 72 72 6f 72 2e 0a 2a 2f 0a  ISUSE error..*/.
0a30: 69 6e 74 20 73 71 6c 69 74 65 33 63 68 61 6e 67  int sqlite3chang
0a40: 65 62 61 74 63 68 5f 61 64 64 28 73 71 6c 69 74  ebatch_add(sqlit
0a50: 65 33 5f 63 68 61 6e 67 65 62 61 74 63 68 2a 2c  e3_changebatch*,
0a60: 20 76 6f 69 64 20 2a 70 2c 20 69 6e 74 20 6e 29   void *p, int n)
0a70: 3b 0a 0a 2f 2a 0a 2a 2a 20 5a 65 72 6f 20 61 20  ;../*.** Zero a 
0a80: 63 68 61 6e 67 65 62 61 74 63 68 20 6f 62 6a 65  changebatch obje
0a90: 63 74 2e 20 54 68 69 73 20 63 61 75 73 65 73 20  ct. This causes 
0aa0: 74 68 65 20 72 65 63 6f 72 64 73 20 6f 66 20 61  the records of a
0ab0: 6c 6c 20 65 61 72 6c 69 65 72 20 0a 2a 2a 20 63  ll earlier .** c
0ac0: 61 6c 6c 73 20 74 6f 20 73 71 6c 69 74 65 33 63  alls to sqlite3c
0ad0: 68 61 6e 67 65 62 61 74 63 68 5f 61 64 64 28 29  hangebatch_add()
0ae0: 20 74 6f 20 62 65 20 64 69 73 63 61 72 64 65 64   to be discarded
0af0: 2e 0a 2a 2f 0a 76 6f 69 64 20 73 71 6c 69 74 65  ..*/.void sqlite
0b00: 33 63 68 61 6e 67 65 62 61 74 63 68 5f 7a 65 72  3changebatch_zer
0b10: 6f 28 73 71 6c 69 74 65 33 5f 63 68 61 6e 67 65  o(sqlite3_change
0b20: 62 61 74 63 68 2a 29 3b 0a 0a 2f 2a 0a 2a 2a 20  batch*);../*.** 
0b30: 52 65 74 75 72 6e 20 61 20 63 6f 70 79 20 6f 66  Return a copy of
0b40: 20 74 68 65 20 66 69 72 73 74 20 61 72 67 75 6d   the first argum
0b50: 65 6e 74 20 70 61 73 73 65 64 20 74 6f 20 74 68  ent passed to th
0b60: 65 20 73 71 6c 69 74 65 33 63 68 61 6e 67 65 62  e sqlite3changeb
0b70: 61 74 63 68 5f 6e 65 77 28 29 0a 2a 2a 20 63 61  atch_new().** ca
0b80: 6c 6c 20 75 73 65 64 20 74 6f 20 63 72 65 61 74  ll used to creat
0b90: 65 20 74 68 65 20 63 68 61 6e 67 65 62 61 74 63  e the changebatc
0ba0: 68 20 6f 62 6a 65 63 74 20 70 61 73 73 65 64 20  h object passed 
0bb0: 61 73 20 74 68 65 20 6f 6e 6c 79 20 61 72 67 75  as the only argu
0bc0: 6d 65 6e 74 0a 2a 2a 20 74 6f 20 74 68 69 73 20  ment.** to this 
0bd0: 66 75 6e 63 74 69 6f 6e 2e 0a 2a 2f 0a 73 71 6c  function..*/.sql
0be0: 69 74 65 33 20 2a 73 71 6c 69 74 65 33 63 68 61  ite3 *sqlite3cha
0bf0: 6e 67 65 62 61 74 63 68 5f 64 62 28 73 71 6c 69  ngebatch_db(sqli
0c00: 74 65 33 5f 63 68 61 6e 67 65 62 61 74 63 68 2a  te3_changebatch*
0c10: 29 3b 0a 0a 2f 2a 0a 2a 2a 20 44 65 6c 65 74 65  );../*.** Delete
0c20: 20 61 20 63 68 61 6e 67 65 62 61 74 63 68 20 6f   a changebatch o
0c30: 62 6a 65 63 74 2e 0a 2a 2f 0a 76 6f 69 64 20 73  bject..*/.void s
0c40: 71 6c 69 74 65 33 63 68 61 6e 67 65 62 61 74 63  qlite3changebatc
0c50: 68 5f 64 65 6c 65 74 65 28 73 71 6c 69 74 65 33  h_delete(sqlite3
0c60: 5f 63 68 61 6e 67 65 62 61 74 63 68 2a 29 3b 0a  _changebatch*);.
0c70: 0a 23 65 6e 64 69 66 20 2f 2a 20 21 64 65 66 69  .#endif /* !defi
0c80: 6e 65 64 28 53 51 4c 49 54 45 43 48 41 4e 47 45  ned(SQLITECHANGE
0c90: 42 41 54 43 48 5f 48 5f 29 20 2a 2f 0a 0a        BATCH_H_) */..