ThreadSafeDatabaseMetadata - ประวัติรุ่นแก้ไข

Tenko เมื่อ 22:12, 5 เมษายน 2567

2024-04-05T22:12:53Z

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 05:12, 6 เมษายน 2567
บรรทัดที่ 89:		บรรทัดที่ 89:
	* If {{code\|lang=python\|is_static}} is {{code\|lang=python\|True}}, just set {{code\|lang=python\|_database}} to the fed database object.		* If {{code\|lang=python\|is_static}} is {{code\|lang=python\|True}}, just set {{code\|lang=python\|_database}} to the fed database object.
	* Otherwise, set the fed object as a proper {{code\|lang=python\|model_id:database_object}} item under the proper key in {{code\|lang=python\|app.db_dict}}.		* Otherwise, set the fed object as a proper {{code\|lang=python\|model_id:database_object}} item under the proper key in {{code\|lang=python\|app.db_dict}}.


			{{The Tenko Shrine}}

Tenko เมื่อ 10:39, 5 เมษายน 2567

2024-04-05T10:39:08Z

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 17:39, 5 เมษายน 2567
บรรทัดที่ 3:		บรรทัดที่ 3:
	== Main Idea & Origin ==		== Main Idea & Origin ==

	The core essential of ~~ThreadSafeMetadata~~ is to somehow map each request to its proper database files, as well as initiate and teardown the database connections without affecting other requests running in parallel.		The core essential of ThreadSafeDatabaseMetadata is to somehow map each request to its proper database files, as well as initiate and teardown the database connections without affecting other requests running in parallel.

	CuneiFox's flavour of ~~ThreadSafeMetadata~~ is derived from what written under [https://www.bookstack.cn/read/peewee-orm-3.14.4-en/spilt.10.cf58f59ae9d0f47d.md Thread-Safety and Multiple Databases] in Peewee 3.14.4 Documentation. (The documentation for this version does not exist on the main channel anymore. The link points to a copied version hosted on another site. The essential content is also copied here for safekeeping.)		CuneiFox's flavour of ThreadSafeDatabaseMetadata is derived from what written under [https://www.bookstack.cn/read/peewee-orm-3.14.4-en/spilt.10.cf58f59ae9d0f47d.md Thread-Safety and Multiple Databases] in Peewee 3.14.4 Documentation. (The documentation for this version does not exist on the main channel anymore. The link points to a copied version hosted on another site. The essential content is also copied here for safekeeping.)

	<syntaxhighlight lang="python" line="1">		<syntaxhighlight lang="python" line="1">

Tenko: /* _set_db */

2024-04-05T02:46:10Z

_set_db

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 09:46, 5 เมษายน 2567
บรรทัดที่ 86:		บรรทัดที่ 86:

	=== _set_db ===		=== _set_db ===
			This function sets the association between the fed database object and the model (and the key in db_dict). It is quite simple.
			* If {{code\|lang=python\|is_static}} is {{code\|lang=python\|True}}, just set {{code\|lang=python\|_database}} to the fed database object.
			* Otherwise, set the fed object as a proper {{code\|lang=python\|model_id:database_object}} item under the proper key in {{code\|lang=python\|app.db_dict}}.

Tenko: /* init */

2024-04-05T02:41:50Z

__init__

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 09:41, 5 เมษายน 2567
บรรทัดที่ 78:		บรรทัดที่ 78:
	** A [[CuneiModel]] with static database path must have the proper path readily declared.		** A [[CuneiModel]] with static database path must have the proper path readily declared.
	** A [[CuneiModel]] with dynamic database path must have the path set to {{code\|lang=python\|None}}.		** A [[CuneiModel]] with dynamic database path must have the path set to {{code\|lang=python\|None}}.
	* '''{{code\|lang=python\|_database}}''' ''(peewee.Database)'': Stores the database object for future reference. This attribute is only applicable when {{code\|lang=python\|1= is_static = True}}.		* '''{{code\|lang=python\|_database}}''' ''(peewee.Database)'': Stores the database object for future reference. This attribute is only applicable when {{code\|lang=python\|is_static}} is {{code\|lang=python\|True}}.

	=== _get_db ===		=== _get_db ===

Tenko: /* _get_db */

2024-04-05T02:41:18Z

_get_db

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 09:41, 5 เมษายน 2567
บรรทัดที่ 81:		บรรทัดที่ 81:

	=== _get_db ===		=== _get_db ===
			This function grabs the proper database object for other parts of the program to work on. It is quite simple.
			* If {{code\|lang=python\|is_static}} is {{code\|lang=python\|True}}, just return whatever {{code\|lang=python\|_database}} is.
			* Otherwise, look into {{code\|lang=python\|app.db_dict}} and return the proper object.

	=== _set_db ===		=== _set_db ===

Tenko: /* init */

2024-04-05T02:36:14Z

__init__

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 09:36, 5 เมษายน 2567
บรรทัดที่ 72:		บรรทัดที่ 72:

	=== __init__ ===		=== __init__ ===
			The main role of this function is to create a Metadata object associated with each specific model. It was found during testing that the function is only run once for each model when it is first encountered.

			There are 2 notable attributes to describe here:
			* '''{{code\|lang=python\|is_static}}''' ''(bool)'': This is a new attribute introduced in CuneiFox. It shows whether the associated [[CuneiModel]] is tied with a statically defined database path or not. As elaborated further under the main article, this property is determined by the path embedded in the database object declared under the model's {{code\|lang=python\|class Meta}} section.
			** A [[CuneiModel]] with static database path must have the proper path readily declared.
			** A [[CuneiModel]] with dynamic database path must have the path set to {{code\|lang=python\|None}}.
			* '''{{code\|lang=python\|_database}}''' ''(peewee.Database)'': Stores the database object for future reference. This attribute is only applicable when {{code\|lang=python\|1= is_static = True}}.

	=== _get_db ===		=== _get_db ===

	=== _set_db ===		=== _set_db ===

Tenko: /* Storage Format */

2024-04-05T02:04:19Z

Storage Format

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 09:04, 5 เมษายน 2567
บรรทัดที่ 35:		บรรทัดที่ 35:
	== Storage Format ==		== Storage Format ==

	To achieve specific storages as outlined in the previous section, CuneiFox employs a dictionary named 'db_dict' stored as an attribute of the main app object~~. The key-value pair within the dict is initiated for each request/thread and teardown (popped) once the request/thread finished~~.		To achieve specific storages as outlined in the previous section, CuneiFox employs a dictionary named 'db_dict' stored as an attribute of the main app object.

	The key for each items is a 2-tuple:		The key for each items is a 2-tuple:
บรรทัดที่ 55:		บรรทัดที่ 55:
	...}		...}
	</syntaxhighlight>		</syntaxhighlight>

			=== Storage Life ===

			The key-value pair within db_dict is initiated for each request/thread and teardown (popped) once the request/thread finished as detailed below. This mean, during operation, the dict only holds values for actively running requests/threads.
			* For client-side requests: This group of items is very short-lived.
			** An item is initiated upon each client-side request as a part of Flask's 'before_request' routine.
			** The item is teardown as a part of Flask's 'teardown_request' routine.
			* For server-side threads: This group is longer-lived, but the initiation and teardown are both parts of CuneiFox automatic routines.
			** An item is initiated as a part of 'establish_key' function when CuneiFox notices the thread is running as a pseudosession.
			** The item is deleted as a closing action of the pseudosessions.
			* For client-side threads: This group requires some care on the developer's part. CuneiFox assumes all long processes requested from the clients to use CuneiFox native task tracking routine. Thus, the initiation and teardown of such db_dict items are tied to said routine.
			** An item is initiated as a part of 'init_task_db'.
			** The item is popped when the thread update its own status to either {{code\|lang=python\|'complete'}} or {{code\|lang=python\|'killed'}} via 'update_task_db'.

	== Key Functions ==		== Key Functions ==

Tenko: /* Storage Format */

2024-04-05T01:40:15Z

Storage Format

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 08:40, 5 เมษายน 2567
บรรทัดที่ 55:		บรรทัดที่ 55:
	...}		...}
	</syntaxhighlight>		</syntaxhighlight>


	== Key Functions ==		== Key Functions ==

Tenko เมื่อ 01:37, 5 เมษายน 2567

2024-04-05T01:37:23Z

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 08:37, 5 เมษายน 2567
บรรทัดที่ 11:		บรรทัดที่ 11:

	import threading		import threading
	from peewee import Metadata		from peewee import Metadata, Model
	class ThreadSafeDatabaseMetadata(Metadata):		class ThreadSafeDatabaseMetadata(Metadata):
	def __init__(self, args, *kwargs):		def __init__(self, args, *kwargs):
บรรทัดที่ 43:		บรรทัดที่ 43:
	* Fallback key: {{code\|lang=python\|('universal', None)}}		* Fallback key: {{code\|lang=python\|('universal', None)}}
	The reusable function 'establish_key' determines the case and key value for each database-related process.		The reusable function 'establish_key' determines the case and key value for each database-related process.

			The value of each dict item is yet another dict with Model ID as the key and the database object (the path to the file is embedded within) as the value.

			<syntaxhighlight lang="python">
			app.db_dict = {tuple key0: {int model_id00: peewee.Database database_object00,
			int model_id01: peewee.Database database_object01,
			...},
			tuple key1: {int model_id10: peewee.Database database_object10,
			int model_id11: peewee.Database database_object11,
			...},
			...}
			</syntaxhighlight>


	== Key Functions ==		== Key Functions ==

Tenko: /* Main Idea & Origin */

2024-04-05T01:22:19Z

Main Idea & Origin

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 08:22, 5 เมษายน 2567
บรรทัดที่ 8:		บรรทัดที่ 8:

	<syntaxhighlight lang="python" line="1">		<syntaxhighlight lang="python" line="1">
			# Content from Peewee 3.14.4 Documentation

	import threading		import threading
	from peewee import Metadata		from peewee import Metadata

ThreadSafeDatabaseMetadata - ประวัติรุ่นแก้ไข

Tenko เมื่อ 22:12, 5 เมษายน 2567

Tenko เมื่อ 10:39, 5 เมษายน 2567

Tenko: /* _set_db */

Tenko: /* __init__ */

Tenko: /* _get_db */

Tenko: /* __init__ */

Tenko: /* Storage Format */

Tenko: /* Storage Format */

Tenko เมื่อ 01:37, 5 เมษายน 2567

Tenko: /* Main Idea & Origin */

Tenko: /* init */

Tenko: /* init */