Solr Index Fields

A list of the fields defined in the solr search index used by the Coordinating Nodes.

These fields are populated by the index processor using values drawn from Types.SystemMetadata, Science Metadata, and Resource Map documents.

Note

For Editors

Definitions are drawn from the solr configuration file and descriptions for each field are contained in a separate properties file (dataone-cn-solr/usr/share/dataone-cn-solr/debian/queryFieldDescriptions.properties). After editing descriptions, the document source must be regenerated and committed to GitHub for the public facing documentation to be updated.

Static Fields

Field Type MV Store Index Description
Index._root_
string False False True  
Index._version_
long False True True  
Index.abstract
text_general False True True The full text of the abstract as provided in the science metadata document.
Index.attribute
text_general True True True Multi-valued field containing the text from attributeName, attributeLabel, attributeDescription, attributeUnit fields into a single searchable text field.
Index.attributeDescription
text_general True True True Multi-valued field containing the attribute descriptive text.
Index.attributeLabel
string True True True Multi-valued field containing secondary attribute name information.
Index.attributeName
string True True True Multi-valued field containing the main attribute name information.
Index.attributeUnit
string True True True Multi-valued field containing the attribute unit information.
Index.author
string False True True Principle Investigator (PI) / Author as listed in the metadata document.
Index.authorGivenName
string False True True The given name of the primary author/PI.
Index.authorGivenNameSort
alphaOnlySort False True True The given name of the primary author/PI case normalized for sorting.
Index.authoritativeMN
string False True True The node Id of the authoritative Member Node for the object.
Index.authorLastName
string True True True The LAST name(s) of the author(s)
Index.authorSurName
string False True True The sur name of the primary author/PI.
Index.authorSurNameSort
alphaOnlySort False True True The sur name of the primary author/PI case normalized for sorting.
Index.awardNumber
string True True True  
Index.awardNumber
string True True True  
Index.awardTitle
string True True True  
Index.awardTitle
string True True True  
Index.beginDate
tdate False True True The starting date of the temporal range of the content described by the metadata document.
Index.blockedReplicationMN
string True True False A multi-valued field that contains the node Ids of member nodes that are blocked from holding replicas of this object.
Index.changePermission
string True True True List of subjects (groups and individuals) that have change permission on PID.
Index.checksum
string False True False The checksum for the object
Index.checksumAlgorithm
string False True False Algorithm used for generating the object checksum
Index.class
string True True True Taxonomic class name(s)
Index.contactOrganization
string True True True Name of the organization to contact for more information about the dataset
Index.contactOrganizationText
text_general True False True Copy from contactOrganization
Index.datasource
string False True True The node Id of the member node that originally contributed the content.
Index.dataUrl
string False True False The URL that can be used to resolve the location of the object given its PID.
Index.dateModified
tdate False True True The date and time when the object system metadata was last updated.
Index.datePublished
tdate False True True Publication date for the dataset (this may or may not be coincident with when the content is added to DataONE).
Index.dateUploaded
tdate False True True The date and time when the object was uploaded to the Member Node.
Index.decade
string False True True The latest decade that is covered by the dataset, expressed in the form “1999-2009”
Index.documents
string True True True Lists all PIDs that this object describes. Obtained by parsing all resource maps in which this object is referenced. Not set for data or resource map objects.
Index.eastBoundCoord
tfloat False True True Eastern most longitude of the spatial extent, in decimal degrees, WGS84
Index.edition
text_general False True True The version or edition number of the item described.
Index.endDate
tdate False True True The ending date of the temporal range of the content described by the metadata document.
Index.family
string True True True Taxonomic family name(s)
Index.fileID
string False True True Contains the CNRead.resolve URL for the object ONLY if the object is a science metadata object.
Index.fileName
string False True True The file name for the object, specified in system metadata field with the same name.
Index.formatId
string False True True The format identifier indicating the type of content this record refers to.
Index.formatType
string False True True The format type of the record - DATA, METADATA, RESOURCE.
Index.funderIdentifier
string True True True  
Index.funderIdentifier
string True True True  
Index.funderName
string True True True  
Index.funderName
string True True True  
Index.funding
string True True True  
Index.funding
string True True True  
Index.fundingText
text_general True False True  
Index.fundingText
text_general True False True  
Index.gcmdKeyword
text_general True True True Keywords drawn from the GCMD controlled vocabulary
Index.genus
string True True True Taxonomic genus name(s)
Index.geoform
string False True True The name of the general form in which the item’s geospatial data is presented
Index.geohash_1
text_general True True True An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.
Index.geohash_2
text_general True True True An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.
Index.geohash_3
text_general True True True An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.
Index.geohash_4
text_general True True True An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.
Index.geohash_5
text_general True True True An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.
Index.geohash_6
text_general True True True An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.
Index.geohash_7
text_general True True True An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.
Index.geohash_8
text_general True True True An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.
Index.geohash_9
text_general True True True An encoded string that represents the geographic coordinates of the centroid of a spatial extent. This can be used for searching and plotting.
Index.id
string False True True The identifier of the object being indexed.
Index.identifier
text_general False True True Copy id
Index.investigator
string True True True Name of the investigator(s) responsible for developing the dataset and associated content.
Index.investigatorText
text_general True False True Copy from investigator.
Index.isDocumentedBy
string True True True Lists all PIDs that describe this object. Obtained by parsing all resource maps in which this object is referenced.
Index.isPublic
boolean False True True Set to True if the DataONE public user is present in the list of subjects with readPermission on PID.
Index.isService
boolean False True True Set to true if document is a member node service description document. Use to filter search results for to exclude or include member node services.
Index.isSpatial
string False True True Set to “Y” for records that contain spatial information
Index.keyConcept
string True True True Terms drawn from a controlled vocabulary of concepts that are applicable to the content described by the metadata document.
Index.keywords
string True True True Keywords recorded in the science metadata document. These may be controlled by the generator of the metadata or by the metadata standard of the document, but are effectively uncontrolled within the DataONE context.
Index.keywordsText
text_general True False True Copy from keywords
Index.kingdom
string True True True Taxonomic kingdom(s)
Index.LTERSite
string False True True Data provider organization identifier, for sources within the LTER network.
Index.mediaType
string False True True The name attribute of the media type element in system metadata. Indicates media type of the object.
Index.mediaTypeProperty
string True True True A list of properties describing the media type in system metadata. The value is a concatenation of the property elements name attribute and the value of the property element.
Index.namedLocation
string True True True The name of the location(s) relevant to the content described by the metadata document.
Index.noBoundingBox
string False True True Set to “Y” if there is no bounding box information available (i.e., the east, west, north, south most coordinates)
Index.northBoundCoord
tfloat False True True Northern most latitude of the spatial extent, in decimal degrees, WGS84
Index.numberReplicas
int False True False Requested number of replicas for the object
Index.obsoletedBy
string False True True If set, indicates the object that replaces this record.
Index.obsoletes
string False True True If set, indicates the object that this record obsoletes.
Index.ogcUrl
text_general False True False URL for Open Geospatial Web service if available.
Index.order
string True True True Taxonomic order name(s)
Index.origin
string True True True Investigator or Investigator organization name.
Index.originator
string True True True Investigator or Investigator organization name. Derived by normalizing origin.
Index.originatorText
text_general True False True  
Index.originText
text_general True False True Copy from origin
Index.parameter
string True True True A characteristic, or variable, that is measured or derived as part of data-collection activities.
Index.parameterText
text_general True False True Copy from parameter
Index.phylum
string True True True Taxonomic phylum (or division) name(s)
Index.placeKey
text_general True True True A place name keyword, assigned by the metadata creator. It is one keyword from the thesaurus named in <placekt>
Index.preferredReplicationMN
string True True False A list of member node identifiers that are preferred replication targets for this object.
Index.presentationCat
string False True True Type of data being preserved (maps, text, etc.)
Index.project
string False True True The authorized name of a research effort for which data is collected. This name is often reduced to a convenient abbreviation or acronym. All investigators involved in a project should use a common, agreed-upon name.
Index.projectText
text_general False False True Copy from project
Index.prov_generated
string True True True A multi-valued field containing the identifiers of data objects that this program generated based on the PROV wasGeneratedBy, qualifiedAssociation, and hadPlan properties.
Index.prov_generatedByExecution
string True True True A multi-valued field containing the identifiers of the executions that this data object was generated by based on the PROV wasGeneratedBy property.
Index.prov_generatedByProgram
string True True True A multi-valued field containing the identifiers of the programs that this data object was generated by based on the PROV wasGeneratedBy, qualifiedAssociation, and hadPlan properties.
Index.prov_generatedByUser
string True True True A multi-valued field containing the identifiers of the users that this data object was generated by based on the PROV wasGeneratedBy, qualifiedAssociation, and agent properties.
Index.prov_hasDerivations
string True True True A multi-valued field containing the identifiers of the data objects that were derivations of the source data object described by this metadata object, based on the PROV wasDerivedBy property.
Index.prov_hasSources
string True True True A multi-valued field containing the identifiers of the data objects that were sources to the derived data object described by this metadata object, based on the PROV wasDerivedBy property.
Index.prov_instanceOfClass
string True True True A multi-valued field containing the identifiers of the semantic classes that this object is an instance of, based on the PROV, ProvONE, and other ontologies.
Index.prov_used
string True True True A multi-valued field containing the identifiers of data objects that this program used based on the PROV used, qualifiedAssociation, and hadPlan properties.
Index.prov_usedByExecution
string True True True A multi-valued field containing the identifiers of the executions that used this data object based on the PROV used property.
Index.prov_usedByProgram
string True True True A multi-valued field containing the identifiers of the programs that used this data object based on the PROV used, qualifiedAssociation, and hadPlan properties.
Index.prov_usedByUser
string True True True A multi-valued field containing the identifiers of the users that used this data object based on the PROV used, qualifiedAssociation, and agent properties.
Index.prov_wasDerivedFrom
string True True True A multi-valued field containing the identifiers of data objects that this data object was derived from based on the PROV wasDerivedBy property.
Index.prov_wasExecutedByExecution
string True True True A multi-valued field containing the identifiers of the executions that used this program based on the PROV qualifiedAssociation, and hadPlan properties.
Index.prov_wasExecutedByUser
string True True True A multi-valued field containing the identifiers of the users that executed this program based on the PROV qualifiedAssociation, hadPlan, and agent properties.
Index.prov_wasInformedBy
string True True True A multi-valued field containing the identifiers of executions that this execution was informed by based on the PROV wasInformedBy property.
Index.pubDate
tdate False True True Publication date for the dataset (this may or may not be coincident with when the content is added to DataONE).
Index.purpose
text_general False True True The “Purpose” describes the “why” aspects of the data set (For example, why was the data set created?).
Index.readPermission
string True True True List of subjects (groups and individuals) that have read permission on PID.
Index.relatedOrganizations
string True True True  
Index.replicaMN
string True True True One or more node Ids holding copies of the object.
Index.replicationAllowed
boolean False True False True if this object can be replicated.
Index.replicaVerifiedDate
tdate True True False  
Index.resourceMap
string True True True List of resource map PIDs that reference this PID.
Index.rightsHolder
string False True True The Subject that acts as the rights holder for the object.
Index.scientificName
string True True True Taxonomic scientific name(s) at the most precise level available for the organisms of relevance to the dataset
Index.sem_annotated_by
string True True True  
Index.sem_annotates
string True True True  
Index.sem_annotation
string True True True  
Index.sem_comment
string True True True  
Index.sensor
string True True True Also called “instrument.” A device that is used for collecting data for a data set.
Index.sensorText
text_general True False True Copy from sensor.
Index.seriesId
string False True True The seriesId is an optional, unique Unicode string that identifies an object revision chain.
Index.serviceCoupling
string False True True Either ‘tight’, ‘mixed’, or ‘loose’. Tight coupled service work only on the data described by this metadata document. Loose coupling means service works on any data. Mixed coupling means service works on data described by this metadata document but may work on other data.
Index.serviceDescription
text_general False True True A human readable description of the member node service to assist discovery and to evaluate applicability.
Index.serviceEndpoint
string True True True A URL that indicates how to access the member node service.
Index.serviceInput
string True True True Aspect of the service that accepts a digital entity. Either a list of DataONE formatIds Urls or pid RESOLVE Urls that the member node service operates on. A pid RESOLVE url indicates a ‘tight’ coupled service - while a list of formatIds indicates a loose coupled service.
Index.serviceOutput
string True True True Aspect of the service that provides a digital entity resulting from operation of the service. A listing of DataONE formatId which this member node service produces.
Index.serviceTitle
text_general False True True A brief, human readable descriptive title for the member node service.
Index.serviceType
string True True True The type of service being provided by the member node.
Index.site
string True True True The name or description of the physical location where the data were collected
Index.siteText
text_general True False True Copy from site.
Index.size
tlong False True True The size of the object, in bytes.
Index.source
string True True True Also called “platform.” The mechanism used to support the sensor or instrument that gathers data
Index.sourceText
text_general True False True Copy from source.
Index.southBoundCoord
tfloat False True True Southern most latitude of the spatial extent, in decimal degrees, WGS84
Index.species
string True True True Taxonomic species name(s)
Index.submitter
string False True True The Subject name of the original submitter of the content to DataONE.
Index.term
string True True True A secondary subject area within which parameters can be categorized. Approved terms include “agricultural chemicals” and “atmospheric chemistry,” among many others. When entering a term in the LandVal Metadata Editor, users should select a standard expression from the pick list for terms if at all possible.
Index.termText
text_general True False True Copy from term.
Index.text
text_en_splitting False True True Full text of the metadata record, used to support full text searches
Index.title
text_general False True True Title of the dataset as recorded in the science metadata.
Index.titlestr
string False False True Copy from title.
Index.topic
string True True True The most general subject area within which a parameter is categorized. Approved topics include “agriculture,” “atmosphere,” and “hydrosphere,” among others.
Index.topicText
text_general True False True Copy from topic.
Index.updateDate
tdate False True True Copy from dateuploaded.
Index.webUrl
string True True False Link to the investigator’s web-site.
Index.westBoundCoord
tfloat False True True Western most longitude of the spatial extent, in decimal degrees, WGS84
Index.writePermission
string True True True List of subjects (groups and individuals) that have write permission on PID.

Dynamic Fields

Field Type MV Store Index Description
*_b
boolean False True True  
*_bm
boolean True True True  
*_bs
boolean True True True  
*_c
currency False True True  
*_coordinate
tdouble False False True  
*_d
double False True True  
*_dm
tdouble True True True  
*_ds
double True True True  
*_dt
date False True True  
*_dtm
tdate True True True  
*_dts
date True True True  
*_en
text_en True True True  
*_f
float False True True  
*_fm
tfloat True True True  
*_fs
float True True True  
*_i
int False True True  
*_im
tint True True True  
*_is
int True True True  
*_l
long False True True  
*_lm
tlong True True True  
*_ls
long True True True  
*_p
location False True True  
*_s
string False True True  
*_sm
string True True True  
*_ss
string True True True  
*_t
text_general False True True  
*_td
tdouble False True True  
*_tdt
tdate False True True  
*_tf
tfloat False True True  
*_ti
tint False True True  
*_tl
tlong False True True  
*_tm
text_general True True True  
*_txt
text_general True True True  
attr_*
text_general True True True  
ignored_*
ignored True False False  
random_*
random False False False