Counter field

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

• Metadata
  • Int field
    • Counter field

Properties

name	default	description
digits	n/a	This property is taken from the repository configuration.
sql_counter	n/a	REQUIRED. This property is taken from the repository configuration.

Required Phrases

No additional phrases.

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" 
},