Difference between revisions of "Bigint field"

From EPrints Documentation
Jump to: navigation, search
(Required Phrases: No additional phrases)
(Actually leave in as should become available)
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{fieldtypes}}
 
{{fieldtypes}}
__NOTOC__
+
 
 +
 
 +
== Description ==
 +
This field represents an integer whose value may be too big to store (i.e. greater than 2,147,483,647 or less than -2,147,483.647) in a standard database [[Int field]].
 +
 
 
== Inheritance ==
 
== Inheritance ==
 
 
* [[Metadata]]
 
* [[Metadata]]
 
** [[Int field]]
 
** [[Int field]]
 
*** [[Bigint field]]
 
*** [[Bigint field]]
  
== Description ==
+
== Additional Properties ==
This field represents an integer whose value may be too big to to store in a standard database integer field.
+
As for [[Int_field#Additional Properties|Int fields]] except for
 
 
== Properties ==
 
  
 
{| border="1" cellpadding="3" cellspacing="0"
 
{| border="1" cellpadding="3" cellspacing="0"
| name || default || description
+
! Name !! Default Value !! Required !! Description !! Notes
 
|-
 
|-
| '''digits''' || n/a || '''This property is taken from the repository configuration.'''
+
| '''digits''' || <tt>18</tt> || NO || The maximum number of digits for the big integer value. || Different from [[Int field]] default (<tt>9</tt>).  Analogous to <tt>maxlength</tt>.  Database <tt>BIGINT(20)</tt> cannot reliably store numbers that takes up more than 18 digits (including a sign if negative).
 
|}
 
|}
  
 
== Required Phrases ==
 
== Required Phrases ==
No additional phrases.
+
No additional phrases beyond those required for [[Int_field#Required_Phrases|Int fields]].
  
 
== Database ==
 
== Database ==
 +
Bigint fields are stored in the database as
 +
fieldname BIGINT(20)
  
Counter fields are stored in the database as
+
== API ==
 +
See [[API:EPrints/MetaField/Bigint|API page]].
  
  fieldname BIGINT(20)
+
== Examples ==
 +
A basic example.
 +
  {
 +
    name => 'population',
 +
    type => 'bigint',
 +
}
 +
Restrict number of digits can be added to this field in the wokflow.
 +
{
 +
    name => 'hesa_id',
 +
    type => 'bigint',
 +
    digits => 13,
 +
}

Latest revision as of 09:46, 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 value may be too big to store (i.e. greater than 2,147,483,647 or less than -2,147,483.647) in a standard database Int field.

Inheritance

Additional Properties

As for Int fields except for

Name Default Value Required Description Notes
digits 18 NO The maximum number of digits for the big integer value. Different from Int field default (9). Analogous to maxlength. Database BIGINT(20) cannot reliably store numbers that takes up more than 18 digits (including a sign if negative).

Required Phrases

No additional phrases beyond those required for Int fields.

Database

Bigint fields are stored in the database as

fieldname BIGINT(20)

API

See API page.

Examples

A basic example.

{
    name => 'population',
    type => 'bigint',
}

Restrict number of digits can be added to this field in the wokflow.

{
    name => 'hesa_id',
    type => 'bigint',
    digits => 13,
}