SRU

1
SRU CQL

• Ralph LeVan
• Senior Research Scientist, OCLC
• levan_at_oclc.org
• Code4Lib Pre-Conference
• Brown University
• 23 February 2009

2
The Basics

• REST-ful API for Search and Retrieve
• CQL A rich, standardized query grammar
• Self-describing service through Explain records

3
REST-ful API for Search and Retrieve

• Base URL http//worldcat.org/identities/search/Id
  entities
• Querystring querylocal.Nameall22ralphlevan2
  2
• Important Optional Parms
• startRecord
• maximumRecords
• recordSchema

4
REST-ful API for Search and Retrieve

• Untrustworthy Optional Parms
• sortKeys

5
REST-ful API for Search and Retrieve

• Amusing Parms
• recordPacking

6
REST-ful API for Search and Retrieve

• Omittable Mandatory Parms
• version
• operation

7
CQL

• Standard Boolean operations
• Search Terms Index relation quotedString
• querydog
• querycql.any exact moby dick
• Indexes defined by server
• Standard relations
• exact, , all, any

8
searchRetrieveResponse

• lt?xml version"1.0" ?gt
• lt?xml-stylesheet type"text/xsl"
  href"/identities/NameFinderResponse.xsl"?gt
• ltsearchRetrieveResponse xmlns"http//www.loc.gov/
  zing/srw/"gt

9
searchRetrieveResponse elements

• ltversiongt1.1lt/versiongt
• ltnumberOfRecordsgt3lt/numberOfRecordsgt
• ltresultSetIdgt6dsxztlt/resultSetIdgt
• ltresultSetIdleTimegt300lt/resultSetIdleTimegt
• ltrecordsgtltrecordgtlt/recordgt...lt/recordsgt
• ltechoedSearchRetrieveRequestgt...
• ltdiagnosticsgt...
• ltextraResponseDatagt...

10
record elements

• ltrecordSchemagt
• infosrw/schema/1/Identitieslt/recordSchemagt
• ltrecordPackinggtxmllt/recordPackinggt
• ltrecordDatagt...
• ltrecordPositiongt1lt/recordPositiongt

11
Explain

• ltexplainResponse xmlns"http//www.loc.gov/zing/sr
  w/"gt
• ltversiongt1.1lt/versiongt
• ltrecordgt
• ltrecordSchemagt
• http//explain.z3950.org/dtd/2.0/lt/recordSchem
  agt
• ltrecordPackinggtxmllt/recordPackinggt
• ltSRWrecordDatagt

12
Explain Record

• ltexplain authoritative"true" xmlns"http//explai
  n.z3950.org/dtd/2.0/"gt
• ltserverInfo protocol"SRW/U"gt
• ltdatabaseInfogt
• ltindexInfogt
• ltschemaInfogt
• ltconfigInfogt

13
indexInfo

• ltset identifier"http//staff.oclc.org/levan/loca
  lContextSets/Identities" name"local"/gt
• ltindexgt
• lttitlegtlocal.BirthDatelt/titlegt
• ltmapgt
• ltname set"local"gtBirthDatelt/namegt
• lt/mapgt
• ltconfigInfogt
• ltsupports type'relation'gtanylt/supportsgt
• lt/configInfogt
• lt/indexgt

14
schemaInfo

• ltschema sort"false" retrieve"true"
  name"Identities"
• identifier"infosrw/schema/1/Identities
• location"http//www.oclc.org/standards/Identities
  /schema/Identities.xsd"gt
• lttitlegtIdentities records in their native
  formatlt/titlegt
• lt/schemagt

15
configInfo

• ltdefault type"maximumRecords"gt250lt/defaultgt
• ltdefault type"numberOfRecords"gt10lt/defaultgt
• ltdefault type"retrieveSchema"gt
• infosrw/schema/1/Identitieslt/defaultgt

16
Links

• http//www.loc.gov/standards/sru/