Information Catalog Manager Programming Guide and Reference

FLGCommit

Commits all changes made to the information catalog since the unit of work was started or since the last commit point.

Authorization

Administrator or user

Syntax

APIRET APIENTRY FLGCommit (PFLGEXTCODE pExtCode)

Parameters

pExtCode (PFLGEXTCODE) -- output

Points to an extended code associated with the reason code. See Appendix D, Information Catalog Manager reason codes to see if a meaningful extended code is associated with the returned reason code.

APIRET

Represents the execution result of this API call.

See Appendix D, Information Catalog Manager reason codes for an explanation of the returned reason codes.

Usage

Your program should call FLGCommit after making changes to the information catalog database to make these changes permanent. In general, you can have your program call FLGCommit after it makes any change to the database.

The following situations are particularly good opportunities for committing changes to the database:

• After updating a series of related metadata values. To keep related information consistent in the information catalog, your program can issue FLGCommit after making a number of related changes.
• After a set of FLGCreateReg and FLGCreateType calls that completely define a new object type, or a set of FLGDeleteType and FLGDeleteReg calls that completely remove an object type. At this point, you know that your program is not committing a partial object type definition.
• After FLGDeleteTree or FLGDeleteTypeExt calls, because these calls make major changes to your information catalog.
• Before FLGAppendType, FLGCreateReg, FLGCreateType, FLGDeleteType, and FLGDeleteTypeExt calls. These API calls automatically roll back the database when they encounter severe database errors. You can issue FLGCommit calls before one or more of these API calls to prevent the Information Catalog Manager from removing uncommitted changes that are not related to the database error if a rollback occurs.
• Before an FLGImport call. The Information Catalog Manager rolls back the database when FLGImport encounters errors. Your program should issue FLGCommit before issuing FLGImport to ensure that the Information Catalog Manager does not also roll back uncommitted changes that occurred before the FLGImport call.

Examples

Figure 45 shows the C language code that calls FLGCommit.

Figure 45. Sample C language call to FLGCommit

APIRET rc; // Declare reason code from FLGCommit FLGEXTCODE ExtCode = 0; // Declare extended code . . rc = FLGCommit(&ExtCode); // pass the address of // extended code

Special error handling

If FLGCommit encounters a database error, the Information Catalog Manager rolls back the database to the previous commit that occurred in your program.

If this rollback is successful, FLGCommit returns the reason code FLG_SEVERR_DB_AUTO_ROLLBACK_COMPLETE. The extended code contains the SQL code for the database error that prompted the Information Catalog Manager to roll back the database.

Attention: If this rollback fails, FLGCommit returns the reason code FLG_SEVERR_DB_AUTO_ROLLBACK_FAIL. The extended code contains the SQL code for the database error that prompted the Information Catalog Manager to roll back the database. In this case, your database could have severe integrity problems, and your program should call FLGTerm to exit the Information Catalog Manager.

Depending on the state of your database, you might need to recover your database using your backed-up database files. For more information about recovering your information catalog database, see the Information Catalog Manager Administration Guide.