Storable field - Revision history

Drn@ecs.soton.ac.uk: /* Additional Properties */

2023-04-16T10:15:56Z

‎Additional Properties

2023-04-10T23:16:56Z

Amended structure to standardise for metadata field type.

2022-02-18T15:37:59Z

Added page for storable field

New page

{{fieldtypes}}

[[Metadata]] field, which is a text serialization of structured data that can be interpreted by EPrints.

@@ Line 14: / Line 14: @@
 == Additional Properties ==
 {| border="1" cellpadding="3" cellspacing="0"
-| name || default || description
+! Name !! Default Value !! Required !! Description !! Notes
 |-
-| '''text_index''' || 0|| '''Different default.'''
+| '''sql_index''' || <tt>0</tt> || NO || Whether field should be index for quicker lookup by the database. || Different from [[Metadata]] default (<tt>1</tt>).
 |}

← Older revision		Revision as of 23:16, 10 April 2023
Line 1:		Line 1:
	{{fieldtypes}}		{{fieldtypes}}

−	[[Metadata]] field~~, which is a text serialization of structured data that can be interpreted by~~ EPrints.	+
		+	== Description ==
		+	This field supports arbitrary Perl data structures by serialising them using <code>Storable</code> perl module, up to the same maximum length of [[Longtext field]]s.
		+
		+	When serialised into XML the values are further encoded in Base64 to avoid any problems with invalid XML character data being emitted by Storable.
		+
		+	This field does <b>not</b> support storing simple scalars, (e.g. "Hello, World!").
		+
		+	== Inheritance ==
		+	* [[Metadata]]
		+	** [[Storable field]]
		+
		+	== Additional Properties ==
		+	{\| border="1" cellpadding="3" cellspacing="0"
		+	\| name \|\| default \|\| description
		+	\|-
		+	\| '''text_index''' \|\| 0\|\| '''Different default.'''
		+	\|-
		+	\| '''sql_index''' \|\| 0 \|\| '''Different default.''
		+	\|}
		+
		+	== Required Phrases ==
		+	No additional phrases beyond the [[Metadata#Required_Phrases\|standard metadata field phrases]].
		+
		+	== Database ==
		+	Storable fields are stored in the database as
		+	fieldname BLOB
		+
		+	== API ==
		+	See [[API:EPrints/MetaField/Storable\|API page]].
		+
		+	== Examples ==
		+	Most basic example.
		+	{
		+	name => 'configuration',
		+	type => 'storable',
		+	}