Difference between revisions of "Storable field"

From EPrints Documentation
Jump to: navigation, search
(Amended structure to standardise for metadata field type.)
(Additional Properties)
 
Line 14: Line 14:
  
 
== Additional Properties ==
 
== Additional Properties ==
 +
 
{| border="1" cellpadding="3" cellspacing="0"
 
{| 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>).
|-
 
| '''sql_index''' || 0 || '''Different default.''
 
 
|}
 
|}
  

Latest revision as of 10:15, 16 April 2023

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


Metadata Fields: Arclanguage - Base64 - Bigint - Boolean - Compound - Counter - Dataobjref - Date - Decimal - Email - Fields - Float - Id - Idci - Image - Int - Itemref - Keywords - Langid - Longtext - Longtext_counter - Multilang - Multipart - Name - Namedset - Pagerange - Recaptcha - Relation - Search - Secret - Set - Storable - Subject - Subobject - Text - Time - Timestamp - Url - Uuid


Description

This field supports arbitrary Perl data structures by serialising them using Storable perl module, up to the same maximum length of Longtext fields.

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 not support storing simple scalars, (e.g. "Hello, World!").

Inheritance

Additional Properties

Name Default Value Required Description Notes
sql_index 0 NO Whether field should be index for quicker lookup by the database. Different from Metadata default (1).

Required Phrases

No additional phrases beyond the standard metadata field phrases.

Database

Storable fields are stored in the database as

 fieldname BLOB

API

See API page.

Examples

Most basic example.

{
    name => 'configuration',
    type => 'storable',
}