.. _introduction: Introduction ============ pycsw is an OGC API - Records and OGC CSW server implementation written in Python. Features ======== - implements `OGC API - Records - Part 1: Core`_ - implements `OGC API - Features - Part 3: Filtering`_ - implements `Common Query Language (CQL2)`_ - certified OGC `Compliant`_ and OGC Reference Implementation for both CSW 2.0.2 and CSW 3.0.0 - harvesting support for WMS, WFS, WCS, WPS, WAF, CSW, SOS - implements `INSPIRE Discovery Services 3.0`_ - implements `ISO Metadata Application Profile 1.0.0`_ - implements `FGDC CSDGM Application Profile for CSW 2.0`_ - implements the Search/Retrieval via URL (`SRU`_) search protocol - implements Full Text Search capabilities - implements OGC OpenSearch Geo and Time Extensions - implements Open Archives Initiative Protocol for Metadata Harvesting - supports ISO, Dublin Core, DIF, FGDC, Atom, GM03 and DataCite metadata models - CGI or WSGI deployment - simple YAML configuration - transactional capabilities (OGC API - Records and CSW-T) - flexible repository configuration - `GeoNode`_ connectivity - `HHypermap`_ connectivity - `Open Data Catalog`_ connectivity - `CKAN`_ connectivity - federated catalogue distributed searching - realtime XML Schema validation - extensible profile plugin architecture Standards Support ----------------- .. csv-table:: :header: Standard,Version(s) `OGC API - Records - Part 1: Core`_,1.0 `OGC API - Features - Part 3: Filtering`_,draft "`OGC API - Features - Part 4: Create, Replace, Update and Delete`_",draft `OGC CSW`_,2.0.2/3.0.0 `OGC Filter`_,1.1.0/2.0.0 `OGC OWS Common`_,1.0.0/2.0.0 `OGC GML`_,3.1.1 `OGC SFSQL`_,1.2.1 `OGC GeoRSS`_,1.0 `Dublin Core`_,1.1 `SOAP`_,1.2 `ISO 19115`_,2003 `ISO 19139`_,2007 `ISO 19119`_,2005 `NASA DIF`_,9.7 `FGDC CSDGM`_,1998 `GM03`_,2.1 `SRU`_,1.1 `OGC OpenSearch`_,1.0 `OAI-PMH`_,2.0 `DataCite`_,4.3 OGC API - Records support ------------------------- - Part 1: Core OGC API - Features support -------------------------- - Part 3: Filtering - Part 4: Create, Replace, Update and Delete CQL --- - Common Query Language (CQL2) Supported Output Formats ^^^^^^^^^^^^^^^^^^^^^^^^ - JSON (default) - XML Supported Filters ^^^^^^^^^^^^^^^^^ - q - datetime - filter / filter-lang (CQL) - bbox - all properties (``property=value``) Paging ^^^^^^ - limit - offset CSW Support ----------- Supported Operations ^^^^^^^^^^^^^^^^^^^^ .. csv-table:: :header: Request,Optionality,Supported,HTTP method binding(s) GetCapabilities,mandatory,yes,GET (KVP) / POST (XML) / SOAP DescribeRecord,mandatory,yes,GET (KVP) / POST (XML) / SOAP GetRecords,mandatory,yes,GET (KVP) / POST (XML) / SOAP GetRecordById,optional,yes,GET (KVP) / POST (XML) / SOAP GetRepositoryItem,optional,yes,GET (KVP) GetDomain,optional,yes,GET (KVP) / POST (XML) / SOAP Harvest,optional,yes,GET (KVP) / POST (XML) / SOAP UnHarvest,optional,no, Transaction,optional,yes,POST (XML) / SOAP .. note:: Asynchronous processing supported for GetRecords and Harvest requests (via ``csw:ResponseHandler``) .. note:: Supported Harvest Resource Types are listed in :ref:`transactions` Supported Output Formats ^^^^^^^^^^^^^^^^^^^^^^^^ - XML (default) - JSON Supported Output Schemas ^^^^^^^^^^^^^^^^^^^^^^^^ - Dublin Core - ISO 19139 - FGDC CSDGM - NASA DIF - Atom - GM03 - DataCite Supported Sorting Functionality ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - ogc:SortBy - ascending or descending - aspatial (queryable properties) - spatial (geometric area) Supported Filters ^^^^^^^^^^^^^^^^^ Full Text Search ^^^^^^^^^^^^^^^^ - csw:AnyText Geometry Operands ^^^^^^^^^^^^^^^^^ - gml:Point - gml:LineString - gml:Polygon - gml:Envelope .. note:: Coordinate transformations are supported Spatial Operators ^^^^^^^^^^^^^^^^^ - BBOX - Beyond - Contains - Crosses - Disjoint - DWithin - Equals - Intersects - Overlaps - Touches - Within Logical Operators ^^^^^^^^^^^^^^^^^ - Between - EqualTo - LessThanEqualTo - GreaterThan - Like - LessThan - GreaterThanEqualTo - NotEqualTo - NullCheck Functions ^^^^^^^^^ - length - lower - ltrim - rtrim - trim - upper OAI-PMH Support --------------- Supported Operations ^^^^^^^^^^^^^^^^^^^^ - GetRecord - Identify - ListIdentifiers - ListMetadataFormats - ListRecords - ListSets Supported Filters ^^^^^^^^^^^^^^^^^ - from - until - set Paging ^^^^^^ - resumptionToken .. _`OGC API - Records - Part 1: Core`: https://ogcapi.ogc.org/records .. _`OGC API - Features - Part 3: Filtering`: http://docs.ogc.org/DRAFTS/19-079.html .. _`Common Query Language (CQL2)`: https://docs.ogc.org/DRAFTS/21-065.html .. _`OGC CSW`: https://www.ogc.org/standards/cat .. _`ISO Metadata Application Profile 1.0.0`: https://portal.ogc.org/files/?artifact_id=21460 .. _`OGC Filter`: https://www.ogc.org/standards/filter .. _`OGC OWS Common`: https://www.ogc.org/standards/common .. _`OGC GML`: https://www.ogc.org/standards/gml .. _`OGC SFSQL`: https://www.ogc.org/standards/sfs .. _`Dublin Core`: https://www.dublincore.org/ .. _`OGC CITE CSW`: https://github.com/opengeospatial/ets-csw202 .. _`OGC GeoRSS`: http://docs.opengeospatial.org/cs/17-002r1/17-002r1.html .. _`SOAP`: https://www.w3.org/TR/soap/ .. _`INSPIRE Discovery Services 3.0`: https://inspire.jrc.ec.europa.eu/documents/Network_Services/TechnicalGuidance_DiscoveryServices_v3.0.pdf .. _`ISO 19115`: https://www.iso.org/iso/catalogue_detail.htm?csnumber=26020 .. _`ISO 19139`: https://www.iso.org/iso/catalogue_detail.htm?csnumber=32557 .. _`ISO 19119`: https://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=39890 .. _`NASA DIF`: https://earthdata.nasa.gov/esdis/eso/standards-and-references/directory-interchange-format-dif-standard .. _`FGDC CSDGM`: https://www.fgdc.gov/metadata/csdgm-standard .. _`FGDC CSDGM Application Profile for CSW 2.0`: https://portal.ogc.org/files/?artifact_id=16936 .. _`SRU`: https://www.loc.gov/standards/sru .. _`OGC OpenSearch`: https://www.ogc.org/standards/opensearchgeo .. _`GeoNode`: https://geonode.org/ .. _`HHypermap`: https://github.com/cga-harvard/HHypermap .. _`Open Data Catalog`: https://github.com/azavea/Open-Data-Catalog/ .. _`CKAN`: https://ckan.org/ .. _`Compliant`: https://www.ogc.org/resource/products/details/?pid=1374 .. _`OAI-PMH`: https://www.openarchives.org/pmh/ .. _`GM03`: https://www.geocat.admin.ch/en/dokumentation/gm03.html .. _`OGC API - Features - Part 4: Create, Replace, Update and Delete`: https://cnn.com .. _`DataCite`: https://schema.datacite.org/meta/kernel-4.3/