Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
Comment: | Fill in doc comments for most of the interfaces. |
---|---|
Downloads: | Tarball | ZIP archive |
Timelines: | family | ancestors | descendants | both | sessions |
Files: | files | file ages | folders |
SHA1: |
381e861fa6ba0c257ee7e8b0d4733741 |
User & Date: | mistachkin 2017-10-14 03:54:19.583 |
Context
2017-10-14
| ||
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 | |
03:25 | Fill in doc comments for the SQLiteSession class. check-in: afe96a0b10 user: mistachkin tags: sessions | |
Changes
Changes to System.Data.SQLite/SQLiteSession.cs.
︙ | ︙ | |||
192 193 194 195 196 197 198 199 200 201 202 203 204 205 | ISQLiteChangeSetMetadataItem item ); #endregion /////////////////////////////////////////////////////////////////////////// #region ISQLiteChangeSet Interface public interface ISQLiteChangeSet : IEnumerable<ISQLiteChangeSetMetadataItem>, IDisposable { ISQLiteChangeSet Invert(); ISQLiteChangeSet CombineWith(ISQLiteChangeSet changeSet); void Apply( | > > > > | 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 | ISQLiteChangeSetMetadataItem item ); #endregion /////////////////////////////////////////////////////////////////////////// #region ISQLiteChangeSet Interface /// <summary> /// This interface contains methods used to manipulate a set of changes for /// a database. /// </summary> public interface ISQLiteChangeSet : IEnumerable<ISQLiteChangeSetMetadataItem>, IDisposable { ISQLiteChangeSet Invert(); ISQLiteChangeSet CombineWith(ISQLiteChangeSet changeSet); void Apply( |
︙ | ︙ | |||
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 | ); } #endregion /////////////////////////////////////////////////////////////////////////// #region ISQLiteChangeGroup Interface public interface ISQLiteChangeGroup : IDisposable { void AddChangeSet(byte[] rawData); void AddChangeSet(Stream stream); void CreateChangeSet(ref byte[] rawData); void CreateChangeSet(Stream stream); } #endregion /////////////////////////////////////////////////////////////////////////// #region ISQLiteChangeSetMetadataItem Interface public interface ISQLiteChangeSetMetadataItem : IDisposable { string TableName { get; } int NumberOfColumns { get; } SQLiteAuthorizerActionCode OperationCode { get; } bool Indirect { get; } bool[] PrimaryKeyColumns { get; } int NumberOfForeignKeyConflicts { get; } SQLiteValue GetOldValue(int columnIndex); SQLiteValue GetNewValue(int columnIndex); SQLiteValue GetConflictValue(int columnIndex); } #endregion /////////////////////////////////////////////////////////////////////////// #region ISQLiteSession Interface public interface ISQLiteSession : IDisposable { bool IsEnabled(); void SetToEnabled(); void SetToDisabled(); bool IsIndirect(); void SetToIndirect(); void SetToDirect(); bool IsEmpty(); void AttachTable(string name); void SetTableFilter( SessionTableFilterCallback callback, object clientData ); void CreateChangeSet(ref byte[] rawData); void CreateChangeSet(Stream stream); void CreatePatchSet(ref byte[] rawData); void CreatePatchSet(Stream stream); void LoadDifferencesFromTable( string fromDatabaseName, string tableName ); } #endregion | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 | ); } #endregion /////////////////////////////////////////////////////////////////////////// #region ISQLiteChangeGroup Interface /// <summary> /// This interface contains methods used to manipulate multiple sets of /// changes for a database. /// </summary> public interface ISQLiteChangeGroup : IDisposable { /// <summary> /// Attempts to add a change set (or patch set) to this change group /// instance. The underlying data must be contained entirely within /// the <paramref name="rawData" /> byte array. /// </summary> /// <param name="rawData"> /// The raw byte data for the specified change set (or patch set). /// </param> void AddChangeSet(byte[] rawData); /// <summary> /// Attempts to add a change set (or patch set) to this change group /// instance. The underlying data will be read from the specified /// <see cref="Stream" />. /// </summary> /// <param name="stream"> /// The <see cref="Stream" /> instance containing the raw change set /// (or patch set) data to read. /// </param> void AddChangeSet(Stream stream); /// <summary> /// Attempts to create and return, via <paramref name="rawData" />, the /// combined set of changes represented by this change group instance. /// </summary> /// <param name="rawData"> /// Upon success, this will contain the raw byte data for all the /// changes in this change group instance. /// </param> void CreateChangeSet(ref byte[] rawData); /// <summary> /// Attempts to create and write, via <paramref name="stream" />, the /// combined set of changes represented by this change group instance. /// </summary> /// <param name="stream"> /// Upon success, the raw byte data for all the changes in this change /// group instance will be written to this <see cref="Stream" />. /// </param> void CreateChangeSet(Stream stream); } #endregion /////////////////////////////////////////////////////////////////////////// #region ISQLiteChangeSetMetadataItem Interface /// <summary> /// This interface contains properties and methods used to fetch metadata /// about one change within a set of changes for a database. /// </summary> public interface ISQLiteChangeSetMetadataItem : IDisposable { /// <summary> /// The name of the table the change was made to. /// </summary> string TableName { get; } /// <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> int NumberOfColumns { get; } /// <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> SQLiteAuthorizerActionCode OperationCode { get; } /// <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> bool Indirect { get; } /// <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> bool[] PrimaryKeyColumns { get; } /// <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> int NumberOfForeignKeyConflicts { get; } /// <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> SQLiteValue GetOldValue(int columnIndex); /// <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> SQLiteValue GetNewValue(int columnIndex); /// <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> SQLiteValue GetConflictValue(int columnIndex); } #endregion /////////////////////////////////////////////////////////////////////////// #region ISQLiteSession Interface /// <summary> /// This interface contains methods to query and manipulate the state of a /// change tracking session for a database. /// </summary> public interface ISQLiteSession : IDisposable { /// <summary> /// Determines if this session is currently tracking changes to its /// associated database. /// </summary> /// <returns> /// Non-zero if changes to the associated database are being trakced; /// otherwise, zero. /// </returns> bool IsEnabled(); /// <summary> /// Enables tracking of changes to the associated database. /// </summary> void SetToEnabled(); /// <summary> /// Disables tracking of changes to the associated database. /// </summary> void SetToDisabled(); /// <summary> /// Determines if this session is currently set to mark changes as /// indirect (i.e. as though they were made via a trigger or foreign /// key action). /// </summary> /// <returns> /// Non-zero if changes to the associated database are being marked as /// indirect; otherwise, zero. /// </returns> bool IsIndirect(); /// <summary> /// Sets the indirect flag for this session. Subsequent changes will /// be marked as indirect until this flag is changed again. /// </summary> void SetToIndirect(); /// <summary> /// Clears the indirect flag for this session. Subsequent changes will /// be marked as direct until this flag is changed again. /// </summary> void SetToDirect(); /// <summary> /// Determines if there are any tracked changes currently within the /// data for this session. /// </summary> /// <returns> /// Non-zero if there are no changes within the data for this session; /// otherwise, zero. /// </returns> bool IsEmpty(); /// <summary> /// Upon success, causes changes to the specified table(s) to start /// being tracked. Any tables impacted by calls to this method will /// not cause the <see cref="SessionTableFilterCallback" /> callback /// to be invoked. /// </summary> /// <param name="name"> /// The name of the table to be tracked -OR- null to track all /// applicable tables within this database. /// </param> void AttachTable(string name); /// <summary> /// This method is used to set the table filter for this instance. /// </summary> /// <param name="callback"> /// The table filter callback -OR- null to clear any existing table /// filter callback. /// </param> /// <param name="clientData"> /// The optional application-defined context data. This value may be /// null. /// </param> void SetTableFilter( SessionTableFilterCallback callback, object clientData ); /// <summary> /// Attempts to create and return, via <paramref name="rawData" />, the /// combined set of changes represented by this session instance. /// </summary> /// <param name="rawData"> /// Upon success, this will contain the raw byte data for all the /// changes in this session instance. /// </param> void CreateChangeSet(ref byte[] rawData); /// <summary> /// Attempts to create and write, via <paramref name="stream" />, the /// combined set of changes represented by this session instance. /// </summary> /// <param name="stream"> /// Upon success, the raw byte data for all the changes in this session /// instance will be written to this <see cref="Stream" />. /// </param> void CreateChangeSet(Stream stream); /// <summary> /// Attempts to create and return, via <paramref name="rawData" />, the /// combined set of changes represented by this session instance as a /// patch set. /// </summary> /// <param name="rawData"> /// Upon success, this will contain the raw byte data for all the /// changes in this session instance. /// </param> void CreatePatchSet(ref byte[] rawData); /// <summary> /// Attempts to create and write, via <paramref name="stream" />, the /// combined set of changes represented by this session instance as a /// patch set. /// </summary> /// <param name="stream"> /// Upon success, the raw byte data for all the changes in this session /// instance will be written to this <see cref="Stream" />. /// </param> void CreatePatchSet(Stream stream); /// <summary> /// This method loads the differences between two tables [with the same /// name, set of columns, and primary key definition] into this session /// instance. /// </summary> /// <param name="fromDatabaseName"> /// The name of the database containing the table with the original /// data (i.e. it will need updating in order to be identical to the /// one within the database associated with this session instance). /// </param> /// <param name="tableName"> /// The name of the table. /// </param> void LoadDifferencesFromTable( string fromDatabaseName, string tableName ); } #endregion |
︙ | ︙ | |||
1262 1263 1264 1265 1266 1267 1268 | /// </summary> /// <param name="context"> /// Optional extra context information. Currently, this will always /// have a value of <see cref="IntPtr.Zero" />. /// </param> /// <param name="pData"> /// A preallocated native buffer to receive the requested input bytes. | | | 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 | /// </summary> /// <param name="context"> /// Optional extra context information. Currently, this will always /// have a value of <see cref="IntPtr.Zero" />. /// </param> /// <param name="pData"> /// A preallocated native buffer to receive the requested input bytes. /// It must be at least <paramref name="nData" /> bytes in size. /// </param> /// <param name="nData"> /// Upon entry, the number of bytes to read. Upon exit, the number of /// bytes actually read. This value may be zero upon exit. /// </param> /// <returns> /// The value <see cref="SQLiteErrorCode.Ok" /> upon success -OR- an |
︙ | ︙ | |||
1334 1335 1336 1337 1338 1339 1340 | /// </summary> /// <param name="context"> /// Optional extra context information. Currently, this will always /// have a value of <see cref="IntPtr.Zero" />. /// </param> /// <param name="pData"> /// A preallocated native buffer containing the requested output | | > | 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 | /// </summary> /// <param name="context"> /// Optional extra context information. Currently, this will always /// have a value of <see cref="IntPtr.Zero" />. /// </param> /// <param name="pData"> /// A preallocated native buffer containing the requested output /// bytes. It must be at least <paramref name="nData" /> bytes in /// size. /// </param> /// <param name="nData"> /// The number of bytes to write. /// </param> /// <returns> /// The value <see cref="SQLiteErrorCode.Ok" /> upon success -OR- an /// appropriate error code upon failure. |
︙ | ︙ |