Truxton clean database - Revision history

Sam at 19:52, 27 July 2022

2022-07-27T19:52:26Z

Sam: /* Return value */

2022-07-26T12:34:48Z

Return value

Sam at 18:19, 25 July 2022

2022-07-25T18:19:59Z

Sam: /* Sample */

2022-07-25T17:50:31Z

Sample

Sam: Created page with "This will go through the tables looking for unreferenced (orphaned) records and delete them. =Syntax= uint32_t truxton_clean_database( uint64_t truxton_hand..."

2021-05-20T20:55:42Z

Created page with "This will go through the tables looking for unreferenced (orphaned) records and delete them. =Syntax= <source lang="C"> uint32_t truxton_clean_database( uint64_t truxton_hand..."

New page

This will go through the tables looking for unreferenced (orphaned) records and delete them.

=Syntax=
<source lang="C">
uint32_t truxton_clean_database( uint64_t truxton_handle );
</source>

=Parameters=
==<code>truxton_handle</code>==
The handle created by the [[truxton_create]] call.

=Return value=
Zero if the message could not be sent to the <code>maintenance</code> queue, non-zero if the message was successfully sent.

=Sample=
<source lang="C" highlight="3">
void clean_your_room( uint64_t truxton )
{
if ( truxton_clean_database( truxton ) != 0 )
{
printf( "FINE! OK!\n" );
}
}
</source>

← Older revision		Revision as of 19:52, 27 July 2022
Line 1:		Line 1:
−	This send a message to the maintenance ETL to go through the tables looking for unreferenced (orphaned) records and delete them.	+	This send a [[Message Bus Messages#Clean Database\|message]] to the maintenance ETL to go through the tables looking for unreferenced (orphaned) records and delete them.

	=Syntax=		=Syntax=

← Older revision		Revision as of 18:19, 25 July 2022
Line 1:		Line 1:
−	This ~~will~~ go through the tables looking for unreferenced (orphaned) records and delete them.	+	This send a message to the maintenance ETL to go through the tables looking for unreferenced (orphaned) records and delete them.

	=Syntax=		=Syntax=

@@ Line 11: / Line 11: @@
 =Return value=
-Zero if the message could not be sent to the <code>maintenance</code> queue, non-zero if the message was successfully sent.
+Zero if the [[Message Bus Messages#Clean Database|message]] could not be sent to the <code>maintenance</code> queue, non-zero if the message was successfully sent.
 =Sample=

@@ Line 19: / Line 19: @@
     if ( truxton_clean_database( truxton ) != 0 )
+    {
-       printf( "FINE! OK!\n" );
+       printf( "FINE! OK!\n" ); // obviously a teenage database
+    }
+}
 </source>