Difference between revisions of "Search field"

From EPrints Documentation
Jump to: navigation, search
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{reference}}
 
 
{{fieldtypes}}
 
{{fieldtypes}}
  
== Inherritance ==
 
 
* [[Metadata]]
 
** [[Search field]]
 
  
 
== Description ==
 
== Description ==
 +
Serialisation of a search over a particular dataset.
  
== Properties ==
+
== Inheritance ==
 +
* [[Metadata]]
 +
** [[Id field]]
 +
*** [[Text field]]
 +
**** [[Longtext field]]
 +
***** [[Search field]]
  
 +
== Additional Properties ==
 
{| border="1" cellpadding="3" cellspacing="0"
 
{| border="1" cellpadding="3" cellspacing="0"
| name || default || description
+
! Name !! Default Value !! Required !! Description !! Notes
 +
|-
 +
| '''datasetid''' || n/a || YES || The ID of the dataset for which this serialised search if over. ||
 
|-
 
|-
| datasetid || n/a || '''This property is always required.'''
+
| '''fieldnames''' || <tt>undef</tt> || NO || Names of fields that can be searched over. ||
 
|-
 
|-
| fieldnames || undef || ...
+
| '''fieldnames_config''' || <tt>undef</tt> || NO || Gets list of fieldnames from a function call. ||
 
|}
 
|}
  
 
== Required Phrases ==
 
== Required Phrases ==
 +
No additional phrases beyond those required for [[Longtext field#Required_Phrases|Longtext fields]].
 +
 +
== Database ==
 +
Search fields are stored in the database as
 +
 +
fieldname LONGTEXT
 +
 +
== API ==
 +
See [[API:EPrints/MetaField/Longtext|API page]].
 +
 +
== Examples ==
 +
Most basic example.
 +
{
 +
    name => "spec",
 +
    type => "search",
 +
    datasetid => "eprint",
 +
}

Latest revision as of 15:54, 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

Serialisation of a search over a particular dataset.

Inheritance

Additional Properties

Name Default Value Required Description Notes
datasetid n/a YES The ID of the dataset for which this serialised search if over.
fieldnames undef NO Names of fields that can be searched over.
fieldnames_config undef NO Gets list of fieldnames from a function call.

Required Phrases

No additional phrases beyond those required for Longtext fields.

Database

Search fields are stored in the database as

fieldname LONGTEXT

API

See API page.

Examples

Most basic example.

{ 
    name => "spec", 
    type => "search", 
    datasetid => "eprint",
}