Counter field: Difference between revisions
Added counter field page |
Reinstate link to API page even though a redirect |
||
| (13 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{fieldtypes}} | {{fieldtypes}} | ||
== Description == | == Description == | ||
This field represents an integer whose default value is an incrementing integer (1,2,3 ...). | This field represents an integer whose default value is an incrementing integer (1,2,3 ...). | ||
== | == Inheritance == | ||
* [[Metadata]] | |||
** [[Int field]] | |||
*** [[Counter field]] | |||
== Additional Properties == | |||
As for [[Int field#Additional Properties|Int fields]] except for: | |||
{| border="1" cellpadding="3" cellspacing="0" | {| border="1" cellpadding="3" cellspacing="0" | ||
! Name !! Default Value !! Required !! Description !! Notes | |||
|- | |- | ||
| ''' | | '''sql_counter''' || n/a || YES || The counter name for this field that appears as <tt>counters</tt> database table. || | ||
|} | |} | ||
== Required Phrases == | == Required Phrases == | ||
No additional phrases beyond those required for [[Int field#Required_Phrases|Int fields]]. | |||
== Database == | == Database == | ||
Counter fields are stored in the database as | |||
fieldname INT(11) | |||
Counter | == API == | ||
See [[API:EPrints/MetaField/Counter|API page]]. | |||
== Examples == | |||
Most basic example. <tt>sql_counter</tt> is required but typically would be set to the same as <tt>name</tt>. | |||
{ | |||
name => "mycounter", | |||
type => "counter", | |||
sql_counter => "mycounter" | |||
} | |||
Typically, you would not want to allow a value for this field to be imported or cloned as it is an auto-incremented field. | |||
{ | |||
name => "subjectcounter", | |||
type => "counter", | |||
required => 1, | |||
import => 0, | |||
can_clone => 0, | |||
sql_counter => "subjectcounter" | |||
}, | |||
Latest revision as of 09:49, 9 July 2024
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 - Recaptcha3 - Relation - Search - Secret - Set - Storable - Subject - Subobject - Text - Time - Timestamp - Url - Uuid
Description
This field represents an integer whose default value is an incrementing integer (1,2,3 ...).
Inheritance
Additional Properties
As for Int fields except for:
| Name | Default Value | Required | Description | Notes |
|---|---|---|---|---|
| sql_counter | n/a | YES | The counter name for this field that appears as counters database table. |
Required Phrases
No additional phrases beyond those required for Int fields.
Database
Counter fields are stored in the database as
fieldname INT(11)
API
See API page.
Examples
Most basic example. sql_counter is required but typically would be set to the same as name.
{
name => "mycounter",
type => "counter",
sql_counter => "mycounter"
}
Typically, you would not want to allow a value for this field to be imported or cloned as it is an auto-incremented field.
{
name => "subjectcounter",
type => "counter",
required => 1,
import => 0,
can_clone => 0,
sql_counter => "subjectcounter"
},