Jump to content

Search field: Difference between revisions

From EPrints Documentation
m Reverted edit of XjwNim, changed back to last version by WikiSysop
 
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
* [[Metadata]]
{{fieldtypes}}
** [[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


Description[edit]

Serialisation of a search over a particular dataset.

Inheritance[edit]

Additional Properties[edit]

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[edit]

No additional phrases beyond those required for Longtext fields.

Database[edit]

Search fields are stored in the database as

fieldname LONGTEXT

API[edit]

See API page.

Examples[edit]

Most basic example.

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