Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
Comment: | More progress on doc comments. |
---|---|
Downloads: | Tarball | ZIP archive |
Timelines: | family | ancestors | descendants | both | sessions |
Files: | files | file ages | folders |
SHA1: |
dfc53a02a6ee4b2e93f12be329972181 |
User & Date: | mistachkin 2017-10-14 04:38:02.398 |
Context
2017-10-14
| ||
06:37 | Final work on the initial draft of the doc comments. check-in: 8f18f2c045 user: mistachkin tags: sessions | |
04:38 | More progress on doc comments. check-in: dfc53a02a6 user: mistachkin tags: sessions | |
03:54 | Fill in doc comments for most of the interfaces. check-in: 381e861fa6 user: mistachkin tags: sessions | |
Changes
Changes to System.Data.SQLite/SQLiteSession.cs.
︙ | ︙ | |||
899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 | #endregion } #endregion /////////////////////////////////////////////////////////////////////////// #region SQLiteChangeSetIterator Class internal class SQLiteChangeSetIterator : IDisposable { #region Private Data private IntPtr iterator; /////////////////////////////////////////////////////////////////////// private bool ownHandle; #endregion /////////////////////////////////////////////////////////////////////// #region Protected Constructors protected SQLiteChangeSetIterator( IntPtr iterator, bool ownHandle ) { this.iterator = iterator; this.ownHandle = ownHandle; } #endregion /////////////////////////////////////////////////////////////////////// #region Private Methods internal void CheckHandle() { if (iterator == IntPtr.Zero) throw new InvalidOperationException("iterator is not open"); } /////////////////////////////////////////////////////////////////////// internal IntPtr GetIntPtr() { return iterator; } #endregion /////////////////////////////////////////////////////////////////////// #region Public Methods public bool Next() { CheckDisposed(); CheckHandle(); SQLiteErrorCode rc = UnsafeNativeMethods.sqlite3changeset_next( iterator); | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 | #endregion } #endregion /////////////////////////////////////////////////////////////////////////// #region SQLiteChangeSetIterator Class /// <summary> /// This class manages the native change set iterator. It is used as the /// base class for the <see cref="SQLiteMemoryChangeSetIterator" /> and /// <see cref="SQLiteStreamChangeSetIterator" /> classes. It knows how to /// advance the native iterator handle as well as finalize it. /// </summary> internal class SQLiteChangeSetIterator : IDisposable { #region Private Data /// <summary> /// The native change set (a.k.a. iterator) handle. /// </summary> private IntPtr iterator; /////////////////////////////////////////////////////////////////////// /// <summary> /// Non-zero if this instance owns the native iterator handle in the /// <see cref="iterator" /> field. In that case, this instance will /// finalize the native iterator handle upon being disposed or /// finalized. /// </summary> private bool ownHandle; #endregion /////////////////////////////////////////////////////////////////////// #region Protected Constructors /// <summary> /// Constructs a new instance of this class using the specified native /// iterator handle. /// </summary> /// <param name="iterator"> /// The native iterator handle to use. /// </param> /// <param name="ownHandle"> /// Non-zero if this instance is to take ownership of the native /// iterator handle specified by <paramref name="iterator" />. /// </param> protected SQLiteChangeSetIterator( IntPtr iterator, bool ownHandle ) { this.iterator = iterator; this.ownHandle = ownHandle; } #endregion /////////////////////////////////////////////////////////////////////// #region Private Methods /// <summary> /// Throws an exception if the native iterator handle is invalid. /// </summary> internal void CheckHandle() { if (iterator == IntPtr.Zero) throw new InvalidOperationException("iterator is not open"); } /////////////////////////////////////////////////////////////////////// /// <summary> /// Used to query the native iterator handle. This method is only used /// by the <see cref="SQLiteChangeSetMetadataItem" /> class. /// </summary> /// <returns> /// The native iterator handle -OR- <see cref="IntPtr.Zero" /> if it /// is not available. /// </returns> internal IntPtr GetIntPtr() { return iterator; } #endregion /////////////////////////////////////////////////////////////////////// #region Public Methods /// <summary> /// Attempts to advance the native iterator handle to its next item. /// </summary> /// <returns> /// Non-zero if the native iterator handle was advanced and contains /// more data; otherwise, zero. If the underlying native API returns /// an unexpected value then an exception will be thrown. /// </returns> public bool Next() { CheckDisposed(); CheckHandle(); SQLiteErrorCode rc = UnsafeNativeMethods.sqlite3changeset_next( iterator); |
︙ | ︙ | |||
976 977 978 979 980 981 982 983 984 985 986 987 988 989 | } } #endregion /////////////////////////////////////////////////////////////////////// #region Static "Factory" Methods public static SQLiteChangeSetIterator Attach( IntPtr iterator ) { return new SQLiteChangeSetIterator(iterator, false); } #endregion | > > > > > > > > > > > > > > > | 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 | } } #endregion /////////////////////////////////////////////////////////////////////// #region Static "Factory" Methods /// <summary> /// Attempts to create an instance of this class that is associated /// with the specified native iterator handle. Ownership of the /// native iterator handle is NOT transferred to the new instance of /// this class. /// </summary> /// <param name="iterator"> /// The native iterator handle to use. /// </param> /// <returns> /// The new instance of this class. No return value is reserved to /// indicate an error; however, if the native iterator handle is not /// valid, any subsequent attempt to make use of it via the returned /// instance of this class may throw exceptions. /// </returns> public static SQLiteChangeSetIterator Attach( IntPtr iterator ) { return new SQLiteChangeSetIterator(iterator, false); } #endregion |
︙ | ︙ | |||
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 | #endregion } #endregion /////////////////////////////////////////////////////////////////////////// #region SQLiteMemoryChangeSetIterator Class internal sealed class SQLiteMemoryChangeSetIterator : SQLiteChangeSetIterator { #region Private Data private IntPtr pData; #endregion /////////////////////////////////////////////////////////////////////// #region Private Constructors private SQLiteMemoryChangeSetIterator( IntPtr pData, IntPtr iterator, bool ownHandle ) : base(iterator, ownHandle) { this.pData = pData; } #endregion /////////////////////////////////////////////////////////////////////// #region Static "Factory" Methods public static SQLiteMemoryChangeSetIterator Create( byte[] rawData ) { SQLiteSessionHelpers.CheckRawData(rawData); SQLiteMemoryChangeSetIterator result = null; | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 | #endregion } #endregion /////////////////////////////////////////////////////////////////////////// #region SQLiteMemoryChangeSetIterator Class /// <summary> /// This class manages the native change set iterator for a set of changes /// contained entirely in memory. /// </summary> internal sealed class SQLiteMemoryChangeSetIterator : SQLiteChangeSetIterator { #region Private Data /// <summary> /// The native memory buffer allocated to contain the set of changes /// associated with this instance. This will always be freed when this /// instance is disposed or finalized. /// </summary> private IntPtr pData; #endregion /////////////////////////////////////////////////////////////////////// #region Private Constructors /// <summary> /// Constructs an instance of this class using the specified native /// memory buffer and native iterator handle. /// </summary> /// <param name="pData"> /// The native memory buffer to use. /// </param> /// <param name="iterator"> /// The native iterator handle to use. /// </param> /// <param name="ownHandle"> /// Non-zero if this instance is to take ownership of the native /// iterator handle specified by <paramref name="iterator" />. /// </param> private SQLiteMemoryChangeSetIterator( IntPtr pData, IntPtr iterator, bool ownHandle ) : base(iterator, ownHandle) { this.pData = pData; } #endregion /////////////////////////////////////////////////////////////////////// #region Static "Factory" Methods /// <summary> /// Attempts to create an instance of this class using the specified /// raw byte data. /// </summary> /// <param name="rawData"> /// The raw byte data containing the set of changes for this native /// iterator. /// </param> /// <returns> /// The new instance of this class -OR- null if it cannot be created. /// </returns> public static SQLiteMemoryChangeSetIterator Create( byte[] rawData ) { SQLiteSessionHelpers.CheckRawData(rawData); SQLiteMemoryChangeSetIterator result = null; |
︙ | ︙ | |||
1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 | #endregion } #endregion /////////////////////////////////////////////////////////////////////////// #region SQLiteStreamChangeSetIterator Class internal sealed class SQLiteStreamChangeSetIterator : SQLiteChangeSetIterator { #region Private Data private SQLiteStreamAdapter streamAdapter; #endregion /////////////////////////////////////////////////////////////////////// #region Private Constructors private SQLiteStreamChangeSetIterator( SQLiteStreamAdapter streamAdapter, IntPtr iterator, bool ownHandle ) : base(iterator, ownHandle) { this.streamAdapter = streamAdapter; } #endregion /////////////////////////////////////////////////////////////////////// #region Static "Factory" Methods public static SQLiteStreamChangeSetIterator Create( Stream stream, SQLiteConnectionFlags flags ) { if (stream == null) throw new ArgumentNullException("stream"); | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 | #endregion } #endregion /////////////////////////////////////////////////////////////////////////// #region SQLiteStreamChangeSetIterator Class /// <summary> /// This class manages the native change set iterator for a set of changes /// backed by a <see cref="Stream" /> instance. /// </summary> internal sealed class SQLiteStreamChangeSetIterator : SQLiteChangeSetIterator { #region Private Data /// <summary> /// The <see cref="SQLiteStreamAdapter" /> instance that is managing /// the underlying <see cref="Stream" /> used as the backing store for /// the set of changes associated with this native change set iterator. /// </summary> private SQLiteStreamAdapter streamAdapter; #endregion /////////////////////////////////////////////////////////////////////// #region Private Constructors /// <summary> /// Constructs an instance of this class using the specified native /// iterator handle and <see cref="SQLiteStreamAdapter" />. /// </summary> /// <param name="streamAdapter"> /// The <see cref="SQLiteStreamAdapter" /> instance to use. /// </param> /// <param name="iterator"> /// The native iterator handle to use. /// </param> /// <param name="ownHandle"> /// Non-zero if this instance is to take ownership of the native /// iterator handle specified by <paramref name="iterator" />. /// </param> private SQLiteStreamChangeSetIterator( SQLiteStreamAdapter streamAdapter, IntPtr iterator, bool ownHandle ) : base(iterator, ownHandle) { this.streamAdapter = streamAdapter; } #endregion /////////////////////////////////////////////////////////////////////// #region Static "Factory" Methods /// <summary> /// Attempts to create an instance of this class using the specified /// <see cref="Stream" />. /// </summary> /// <param name="stream"> /// The <see cref="Stream" /> where the raw byte data for the set of /// changes may be read. /// </param> /// <param name="flags"> /// The flags associated with the parent connection. /// </param> /// <returns> /// The new instance of this class -OR- null if it cannot be created. /// </returns> public static SQLiteStreamChangeSetIterator Create( Stream stream, SQLiteConnectionFlags flags ) { if (stream == null) throw new ArgumentNullException("stream"); |
︙ | ︙ | |||
4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 | #endregion } #endregion /////////////////////////////////////////////////////////////////////////// #region SQLiteChangeSetMetadataItem Class internal sealed class SQLiteChangeSetMetadataItem : ISQLiteChangeSetMetadataItem { #region Private Data private SQLiteChangeSetIterator iterator; #endregion /////////////////////////////////////////////////////////////////////// #region Public Constructors public SQLiteChangeSetMetadataItem( SQLiteChangeSetIterator iterator ) { this.iterator = iterator; } #endregion /////////////////////////////////////////////////////////////////////// #region Private Methods private void CheckIterator() { if (iterator == null) throw new InvalidOperationException("iterator unavailable"); iterator.CheckHandle(); } /////////////////////////////////////////////////////////////////////// private void PopulateOperationMetadata() { if ((tableName == null) || (numberOfColumns == null) || (operationCode == null) || (indirect == null)) { CheckIterator(); | > > > > > > > > > > > > > > > > > > > > > > > > > | 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 | #endregion } #endregion /////////////////////////////////////////////////////////////////////////// #region SQLiteChangeSetMetadataItem Class /// <summary> /// This interface implements properties and methods used to fetch metadata /// about one change within a set of changes for a database. /// </summary> internal sealed class SQLiteChangeSetMetadataItem : ISQLiteChangeSetMetadataItem { #region Private Data /// <summary> /// The <see cref="SQLiteChangeSetIterator" /> instance to use. This /// will NOT be owned by this class and will not be disposed upon this /// class being disposed or finalized. /// </summary> private SQLiteChangeSetIterator iterator; #endregion /////////////////////////////////////////////////////////////////////// #region Public Constructors /// <summary> /// Constructs an instance of this class using the specified iterator /// instance. /// </summary> /// <param name="iterator"> /// The native iterator handle to use. /// </param> public SQLiteChangeSetMetadataItem( SQLiteChangeSetIterator iterator ) { this.iterator = iterator; } #endregion /////////////////////////////////////////////////////////////////////// #region Private Methods /// <summary> /// Throws an exception if the managed iterator instance is invalid. /// </summary> private void CheckIterator() { if (iterator == null) throw new InvalidOperationException("iterator unavailable"); iterator.CheckHandle(); } /////////////////////////////////////////////////////////////////////// /// <summary> /// Populates the underlying data for the <see cref="TableName" />, /// <see cref="NumberOfColumns" />, <see cref="OperationCode" />, and /// <see cref="Indirect" /> properties, using the appropriate native /// API. /// </summary> private void PopulateOperationMetadata() { if ((tableName == null) || (numberOfColumns == null) || (operationCode == null) || (indirect == null)) { CheckIterator(); |
︙ | ︙ | |||
4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 | operationCode = op; indirect = (bIndirect != 0); } } /////////////////////////////////////////////////////////////////////// private void PopulatePrimaryKeyColumns() { if (primaryKeyColumns == null) { CheckIterator(); IntPtr pPrimaryKeys = IntPtr.Zero; | > > > > > | 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 | operationCode = op; indirect = (bIndirect != 0); } } /////////////////////////////////////////////////////////////////////// /// <summary> /// Populates the underlying data for the /// <see cref="PrimaryKeyColumns" /> property using the appropriate /// native API. /// </summary> private void PopulatePrimaryKeyColumns() { if (primaryKeyColumns == null) { CheckIterator(); IntPtr pPrimaryKeys = IntPtr.Zero; |
︙ | ︙ | |||
4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 | primaryKeyColumns[index] = (bytes[index] != 0); } } } /////////////////////////////////////////////////////////////////////// private void PopulateNumberOfForeignKeyConflicts() { if (numberOfForeignKeyConflicts == null) { CheckIterator(); int conflicts = 0; | > > > > > | 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 | primaryKeyColumns[index] = (bytes[index] != 0); } } } /////////////////////////////////////////////////////////////////////// /// <summary> /// Populates the underlying data for the /// <see cref="NumberOfForeignKeyConflicts" /> property using the /// appropriate native API. /// </summary> private void PopulateNumberOfForeignKeyConflicts() { if (numberOfForeignKeyConflicts == null) { CheckIterator(); int conflicts = 0; |
︙ | ︙ | |||
4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 | } } #endregion /////////////////////////////////////////////////////////////////////// #region ISQLiteChangeSetMetadataItem Members private string tableName; public string TableName { get { CheckDisposed(); PopulateOperationMetadata(); return tableName; } } /////////////////////////////////////////////////////////////////////// private int? numberOfColumns; public int NumberOfColumns { get { CheckDisposed(); PopulateOperationMetadata(); return (int)numberOfColumns; } } /////////////////////////////////////////////////////////////////////// private SQLiteAuthorizerActionCode? operationCode; public SQLiteAuthorizerActionCode OperationCode { get { CheckDisposed(); PopulateOperationMetadata(); return (SQLiteAuthorizerActionCode)operationCode; } } /////////////////////////////////////////////////////////////////////// private bool? indirect; public bool Indirect { get { CheckDisposed(); PopulateOperationMetadata(); return (bool)indirect; } } /////////////////////////////////////////////////////////////////////// private bool[] primaryKeyColumns; public bool[] PrimaryKeyColumns { get { CheckDisposed(); PopulatePrimaryKeyColumns(); return primaryKeyColumns; } } /////////////////////////////////////////////////////////////////////// private int? numberOfForeignKeyConflicts; public int NumberOfForeignKeyConflicts { get { CheckDisposed(); PopulateNumberOfForeignKeyConflicts(); return (int)numberOfForeignKeyConflicts; } } /////////////////////////////////////////////////////////////////////// public SQLiteValue GetOldValue( int columnIndex ) { CheckDisposed(); CheckIterator(); IntPtr pValue = IntPtr.Zero; SQLiteErrorCode rc = UnsafeNativeMethods.sqlite3changeset_old( iterator.GetIntPtr(), columnIndex, ref pValue); return SQLiteValue.FromIntPtr(pValue); } /////////////////////////////////////////////////////////////////////// public SQLiteValue GetNewValue( int columnIndex ) { CheckDisposed(); CheckIterator(); IntPtr pValue = IntPtr.Zero; SQLiteErrorCode rc = UnsafeNativeMethods.sqlite3changeset_new( iterator.GetIntPtr(), columnIndex, ref pValue); return SQLiteValue.FromIntPtr(pValue); } /////////////////////////////////////////////////////////////////////// public SQLiteValue GetConflictValue( int columnIndex ) { CheckDisposed(); CheckIterator(); | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 | } } #endregion /////////////////////////////////////////////////////////////////////// #region ISQLiteChangeSetMetadataItem Members /// <summary> /// Backing field for the <see cref="TableName" /> property. This value /// will be null if this field has not yet been populated via the /// underlying native API. /// </summary> private string tableName; /// <summary> /// The name of the table the change was made to. /// </summary> public string TableName { get { CheckDisposed(); PopulateOperationMetadata(); return tableName; } } /////////////////////////////////////////////////////////////////////// /// <summary> /// Backing field for the <see cref="NumberOfColumns" /> property. This /// value will be null if this field has not yet been populated via the /// underlying native API. /// </summary> private int? numberOfColumns; /// <summary> /// The number of columns impacted by this change. This value can be /// used to determine the highest valid column index that may be used /// with the <see cref="GetOldValue" />, <see cref="GetNewValue" />, /// and <see cref="GetConflictValue" /> methods of this interface. It /// will be this value minus one. /// </summary> public int NumberOfColumns { get { CheckDisposed(); PopulateOperationMetadata(); return (int)numberOfColumns; } } /////////////////////////////////////////////////////////////////////// /// <summary> /// Backing field for the <see cref="OperationCode" /> property. This /// value will be null if this field has not yet been populated via the /// underlying native API. /// </summary> private SQLiteAuthorizerActionCode? operationCode; /// <summary> /// This will contain the value /// <see cref="SQLiteAuthorizerActionCode.Insert" />, /// <see cref="SQLiteAuthorizerActionCode.Update" />, or /// <see cref="SQLiteAuthorizerActionCode.Delete" />, corresponding to /// the overall type of change this item represents. /// </summary> public SQLiteAuthorizerActionCode OperationCode { get { CheckDisposed(); PopulateOperationMetadata(); return (SQLiteAuthorizerActionCode)operationCode; } } /////////////////////////////////////////////////////////////////////// /// <summary> /// Backing field for the <see cref="Indirect" /> property. This value /// will be null if this field has not yet been populated via the /// underlying native API. /// </summary> private bool? indirect; /// <summary> /// Non-zero if this change is considered to be indirect (i.e. as /// though they were made via a trigger or foreign key action). /// </summary> public bool Indirect { get { CheckDisposed(); PopulateOperationMetadata(); return (bool)indirect; } } /////////////////////////////////////////////////////////////////////// /// <summary> /// Backing field for the <see cref="PrimaryKeyColumns" /> property. /// This value will be null if this field has not yet been populated /// via the underlying native API. /// </summary> private bool[] primaryKeyColumns; /// <summary> /// This array contains a <see cref="Boolean" /> for each column in /// the table associated with this change. The element will be zero /// if the column is not part of the primary key; otherwise, it will /// be non-zero. /// </summary> public bool[] PrimaryKeyColumns { get { CheckDisposed(); PopulatePrimaryKeyColumns(); return primaryKeyColumns; } } /////////////////////////////////////////////////////////////////////// /// <summary> /// Backing field for the <see cref="NumberOfForeignKeyConflicts" /> /// property. This value will be null if this field has not yet been /// populated via the underlying native API. /// </summary> private int? numberOfForeignKeyConflicts; /// <summary> /// This method may only be called from within a /// <see cref="SessionConflictCallback" /> delegate when the conflict /// type is <see cref="SQLiteChangeSetConflictType.ForeignKey" />. It /// returns the total number of known foreign key violations in the /// destination database. /// </summary> public int NumberOfForeignKeyConflicts { get { CheckDisposed(); PopulateNumberOfForeignKeyConflicts(); return (int)numberOfForeignKeyConflicts; } } /////////////////////////////////////////////////////////////////////// /// <summary> /// Queries and returns the original value of a given column for this /// change. This method may only be called when the /// <see cref="OperationCode" /> has a value of /// <see cref="SQLiteAuthorizerActionCode.Update" /> or /// <see cref="SQLiteAuthorizerActionCode.Delete" />. /// </summary> /// <param name="columnIndex"> /// The index for the column. This value must be between zero and one /// less than the total number of columns for this table. /// </param> /// <returns> /// The original value of a given column for this change. /// </returns> public SQLiteValue GetOldValue( int columnIndex ) { CheckDisposed(); CheckIterator(); IntPtr pValue = IntPtr.Zero; SQLiteErrorCode rc = UnsafeNativeMethods.sqlite3changeset_old( iterator.GetIntPtr(), columnIndex, ref pValue); return SQLiteValue.FromIntPtr(pValue); } /////////////////////////////////////////////////////////////////////// /// <summary> /// Queries and returns the updated value of a given column for this /// change. This method may only be called when the /// <see cref="OperationCode" /> has a value of /// <see cref="SQLiteAuthorizerActionCode.Insert" /> or /// <see cref="SQLiteAuthorizerActionCode.Update" />. /// </summary> /// <param name="columnIndex"> /// The index for the column. This value must be between zero and one /// less than the total number of columns for this table. /// </param> /// <returns> /// The updated value of a given column for this change. /// </returns> public SQLiteValue GetNewValue( int columnIndex ) { CheckDisposed(); CheckIterator(); IntPtr pValue = IntPtr.Zero; SQLiteErrorCode rc = UnsafeNativeMethods.sqlite3changeset_new( iterator.GetIntPtr(), columnIndex, ref pValue); return SQLiteValue.FromIntPtr(pValue); } /////////////////////////////////////////////////////////////////////// /// <summary> /// Queries and returns the conflicting value of a given column for /// this change. This method may only be called from within a /// <see cref="SessionConflictCallback" /> delegate when the conflict /// type is <see cref="SQLiteChangeSetConflictType.Data" /> or /// <see cref="SQLiteChangeSetConflictType.Conflict" />. /// </summary> /// <param name="columnIndex"> /// The index for the column. This value must be between zero and one /// less than the total number of columns for this table. /// </param> /// <returns> /// The conflicting value of a given column for this change. /// </returns> public SQLiteValue GetConflictValue( int columnIndex ) { CheckDisposed(); CheckIterator(); |
︙ | ︙ |