Depot - Revision history

Sam: /* Retrieving a File */

2024-09-30T11:21:33Z

Retrieving a File

Sam: /* XML Fields */

2023-03-02T10:12:46Z

XML Fields

Sam at 10:12, 2 March 2023

2023-03-02T10:12:02Z

Sam: /* Retrieving a File */

2023-03-02T10:09:04Z

Retrieving a File

Sam at 12:13, 13 July 2022

2022-07-13T12:13:00Z

Sam: /* Data Alignment */

2022-05-25T15:18:51Z

Data Alignment

Sam: /* Retrieving a File */

2022-05-25T15:16:51Z

Retrieving a File

Sam: /* Retrieving a File */

2022-05-25T15:13:16Z

Retrieving a File

Sam: /* Retrieving a File */

2022-05-25T15:13:01Z

Retrieving a File

Sam at 15:12, 25 May 2022

2022-05-25T15:12:27Z

← Older revision		Revision as of 11:21, 30 September 2024
Line 139:		Line 139:
	# Open the file, seek to the offset and read bytes for the given length. If the file cannot be opened, open the URI and read the byte range.		# Open the file, seek to the offset and read bytes for the given length. If the file cannot be opened, open the URI and read the byte range.

−	When using the <code>[[truxton_message_get_file]]</code> API, it performs the steps above.	+	When using the <code>[[truxton_message_get_file]]</code> C API, it performs the steps above.
		+	The Python methods [[TruxtonObject#getfileid.28file_id:_str_.7C_UUID.29_-.3E_TruxtonFileIO\|getfileid()]] and [[TruxtonMessage#file.28.29_-.3E_TruxtonFileIO\|file()]] also do this for you.

@@ Line 48: / Line 48: @@
 |-
 | <code>depot_id</code>
-| The identifier for this depot file. This should correspond to the <code>[ID]</code> column of the <code>[Depot]</code> table in the database.
+| The identifier for this depot file. This should correspond to the <code>[ID]</code> column of the <code><nowiki>[</nowiki>[[Depot Table|Depot]]<nowiki>]</nowiki></code> table in the database.
 |-
 | <code>page_size</code>

@@ Line 1: / Line 1: @@
 Truxton stores file contents in large files called depots.
-When you store a stream of bytes in a depot, the offset of the beginning of the stream in the depot and the stream length are recorded in the <code>[Content]</code> table in the database.
+When you store a stream of bytes in a depot, the offset of the beginning of the stream in the depot and the stream length are recorded in the <code><nowiki>[</nowiki>[[Content Table|Content]]<nowiki>]</nowiki></code> table in the database.
 =File Format=

@@ Line 133: / Line 133: @@
 To retrieve a file from a depot, you must first know where the file's contents exist in the depot.
 When anything in Truxton needs a file's contents it will follow these steps:
-# Retrieve the file's [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID]. This comes from the <code>[ID]</code> column of the <code>File</code> table.
+# Retrieve the file's [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID]. This comes from the <code>[ID]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table.
-# Retrieve the [https://en.wikipedia.org/wiki/MD5 MD5]. This comes from the <code>[HashID]</code> column of the <code>File</code> table.
+# Retrieve the [https://en.wikipedia.org/wiki/MD5 MD5]. This comes from the <code>[HashID]</code> column of the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table.
-# Retrieve the <code>[DepotID]</code>, <code>[Offset]</code> and <code>[Length]</code> values from the <code>[Content]</code> table when the <code>[Hash]</code> column matches the MD5.
+# Retrieve the <code>[DepotID]</code>, <code>[Offset]</code> and <code>[Length]</code> values from the <code><nowiki>[</nowiki>[[Content Table|Content]]<nowiki>]</nowiki></code> table when the <code>[Hash]</code> column matches the MD5.
-# Retrieve the <code>[Filename]</code> and <code>[URI]</code> columns from the <code>[Depot]</code> table when the <code>[ID]</code> column matches the depot identifier.
+# Retrieve the <code>[Filename]</code> and <code>[URI]</code> columns from the <code><nowiki>[</nowiki>[[Depot Table|Depot]]<nowiki>]</nowiki></code> table when the <code>[ID]</code> column matches the depot identifier.
 # Open the file, seek to the offset and read bytes for the given length. If the file cannot be opened, open the URI and read the byte range.
 When using the <code>[[truxton_message_get_file]]</code> API, it performs the steps above.

@@ Line 1: / Line 1: @@
 Truxton stores file contents in large files called depots.
-When you store a stream of bytes in a depot, the offset of the beginning of the stream in the depot and the depot length are recorded in <code>[Content]</code> table in the database.
+When you store a stream of bytes in a depot, the offset of the beginning of the stream in the depot and the stream length are recorded in the <code>[Content]</code> table in the database.
 =File Format=

@@ Line 120: / Line 120: @@
 They are aligned on a 512 byte boundary as this most closely matches hard drive sectors.
 If we were to align on 4KB or 8KB boundaries, [https://en.wikipedia.org/wiki/File_carving carving] would be nearly impossible.
 =Depot Deletion=

← Older revision		Revision as of 15:16, 25 May 2022
Line 135:		Line 135:
	# Retrieve the <code>[Filename]</code> and <code>[URI]</code> columns from the <code>[Depot]</code> table when the <code>[ID]</code> column matches the depot identifier.		# Retrieve the <code>[Filename]</code> and <code>[URI]</code> columns from the <code>[Depot]</code> table when the <code>[ID]</code> column matches the depot identifier.
	# Open the file, seek to the offset and read bytes for the given length. If the file cannot be opened, open the URI and read the byte range.		# Open the file, seek to the offset and read bytes for the given length. If the file cannot be opened, open the URI and read the byte range.
		+
		+	When using the <code>[[truxton_message_get_file]]</code> API, it performs the steps above.

@@ Line 128: / Line 128: @@
 =Retrieving a File=
-To retrieve a file from a depot, you must first know where in the depot the file's contents exist.
+To retrieve a file from a depot, you must first know where the file's contents exist in the depot.
 When anything in Truxton need's a file's contents it will follow these steps:
 # Retrieve the file's [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID]. This comes from the <code>[ID]</code> column of the <code>File</code> table.

← Older revision		Revision as of 15:12, 25 May 2022
Line 126:		Line 126:
	* <code>enabledeletedepots</code> - A boolean value that must be set to true to enable the deletion of depot files		* <code>enabledeletedepots</code> - A boolean value that must be set to true to enable the deletion of depot files
	* <code>softdeletedepots</code> - Instead of deleting the depot file, rename it giving it an extension of <code>.ToBeDeleted</code>		* <code>softdeletedepots</code> - Instead of deleting the depot file, rename it giving it an extension of <code>.ToBeDeleted</code>
		+
		+	=Retrieving a File=
		+	To retrieve a file from a depot, you must first know where in the depot the file's contents exist.
		+	When anything in Truxton need's a file's contents it will follow these steps:
		+	# Retrieve the file's [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID]. This comes from the <code>[ID]</code> column of the <code>File</code> table.
		+	# Retrieve the [https://en.wikipedia.org/wiki/MD5 MD5]. This comes from the <code>[HashID]</code> column of the <code>File</code> table.
		+	# Retrieve the <code>[DepotID]</code>, <code>[Offset]</code> and <code>[Length]</code> values from the <code>[Content]</code> table when the <code>[Hash]</code> column matches the MD5.
		+	# Retrieve the <code>[Filename]</code> and <code>[URI]</code> columns from the <code>[Depot]</code> table when the <code>[ID]</code> column matches the depot identifier.
		+	# Open the file, seek to the offset and read bytes for the given length. If the file cannot be opened, open the URI and read the byte range.