Publication Date: 2018-mm-dd

Approval Date: 2018-mm-dd

Posted Date: 2018-xx-xx

Reference number of this document: OGC 18-024

Reference URL for this document: http://www.opengis.net/doc/PER/t13-xxx

Category: Release Notes

Editor: Jeff Yutzler

Title: Release Notes for GeoPackage v1.2.1


Revision Notes

COPYRIGHT

Copyright © 2018 Open Geospatial Consortium. To obtain additional rights of use, visit http://www.opengeospatial.org/

WARNING

This document is not an OGC Standard. It is distributed for review and comment. It is subject to change without notice and may not be referred to as an OGC Standard. Further, any OGC Engineering Report should not be referenced as required or mandatory technology in procurements. However, the discussions in this document could very well lead to the definition of an OGC Standard.

LICENSE AGREEMENT

Permission is hereby granted by the Open Geospatial Consortium, ("Licensor"), free of charge and subject to the terms set forth below, to any person obtaining a copy of this Intellectual Property and any associated documentation, to deal in the Intellectual Property without restriction (except as set forth below), including without limitation the rights to implement, use, copy, modify, merge, publish, distribute, and/or sublicense copies of the Intellectual Property, and to permit persons to whom the Intellectual Property is furnished to do so, provided that all copyright notices on the intellectual property are retained intact and that each person to whom the Intellectual Property is furnished agrees to the terms of this Agreement.

If you modify the Intellectual Property, all copies of the modified Intellectual Property must include, in addition to the above copyright notice, a notice that the Intellectual Property includes modifications that have not been approved or adopted by LICENSOR.

THIS LICENSE IS A COPYRIGHT LICENSE ONLY, AND DOES NOT CONVEY ANY RIGHTS UNDER ANY PATENTS THAT MAY BE IN FORCE ANYWHERE IN THE WORLD. THE INTELLECTUAL PROPERTY IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE DO NOT WARRANT THAT THE FUNCTIONS CONTAINED IN THE INTELLECTUAL PROPERTY WILL MEET YOUR REQUIREMENTS OR THAT THE OPERATION OF THE INTELLECTUAL PROPERTY WILL BE UNINTERRUPTED OR ERROR FREE. ANY USE OF THE INTELLECTUAL PROPERTY SHALL BE MADE ENTIRELY AT THE USER’S OWN RISK. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR ANY CONTRIBUTOR OF INTELLECTUAL PROPERTY RIGHTS TO THE INTELLECTUAL PROPERTY BE LIABLE FOR ANY CLAIM, OR ANY DIRECT, SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM ANY ALLEGED INFRINGEMENT OR ANY LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR UNDER ANY OTHER LEGAL THEORY, ARISING OUT OF OR IN CONNECTION WITH THE IMPLEMENTATION, USE, COMMERCIALIZATION OR PERFORMANCE OF THIS INTELLECTUAL PROPERTY.

This license is effective until terminated. You may terminate it at any time by destroying the Intellectual Property together with all copies in any form. The license will also terminate if you fail to comply with any term or condition of this Agreement. Except as provided in the following sentence, no such termination of this license shall require the termination of any third party end-user sublicense to the Intellectual Property which is in force as of the date of notice of such termination. In addition, should the Intellectual Property, or the operation of the Intellectual Property, infringe, or in LICENSOR’s sole opinion be likely to infringe, any patent, copyright, trademark or other right of a third party, you agree that LICENSOR, in its sole discretion, may terminate this license without any compensation or liability to you, your licensees or any other party. You agree upon termination of any kind to destroy or cause to be destroyed the Intellectual Property together with all copies in any form, whether held by you or by any third party.

Except as contained in this notice, the name of LICENSOR or of any other holder of a copyright in all or part of the Intellectual Property shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Intellectual Property without prior written authorization of LICENSOR or such copyright holder. LICENSOR is and shall at all times be the sole entity that may authorize you or any third party to use certification marks, trademarks or other special designations to indicate compliance with any LICENSOR standards or specifications.

This Agreement is governed by the laws of the Commonwealth of Massachusetts. The application to this Agreement of the United Nations Convention on Contracts for the International Sale of Goods is hereby expressly excluded. In the event any provision of this Agreement shall be deemed unenforceable, void or invalid, such provision shall be modified so as to make it valid and enforceable, and as so modified the entire Agreement shall remain in full force and effect. No decision, action or inaction by LICENSOR shall be construed to be a waiver of any rights or remedies available to it.

None of the Intellectual Property or underlying information or technology may be downloaded or otherwise exported or reexported in violation of U.S. export laws and regulations. In addition, you are responsible for complying with any local laws in your jurisdiction which may impact your right to import, export or use the Intellectual Property, and you represent that you have complied with any regulations or registration procedures required by applicable law to make this license enforceable.

Preface

This document provides the set of revision notes for the existing GeoPackage version 1.2.1 (OGC 12-128r15) and does not modify that standard.

This document was approved by the OGC membership on approval date. As a result of the OGC Standards Working Group (SWG) process, there were a number of edits and enhancements made to this standard. This document provides the details of those edits, deficiency corrections, and enhancements. It also documents those items that have been deprecated. Finally, this document provides implementations details related to issues of backwards compatibility.

Keywords

ogcdoc, geopackage, sqlite, raster, tiles, vector, feature, data, storage, exchange, mobile, smartphone, tablet

1. Introduction

1.1. Scope

GeoPackage is an open, standards-based, platform-independent, portable, self-describing, compact format for transferring geospatial information.

Over the course of 2017 and 2018, the GeoPackage Standards Working Group (SWG) made a number of changes to the GeoPackage Encoding Standard Version 1.2 (OGC 12-128r14). These changes have been aggregated into version 1.2.1 of the GeoPackage Encoding Standard (12-128r14). This document describes those changes.

GeoPackage 1.2.1 is a corrigendum revision to version 1.2.0. An OGC Corrigendum release is focused on correcting errors, bugs, and/or deficiencies. While a corrigendum release can break backwards compatibility (such as correcting a schema error), the SWG has worked hard to ensure that this corrigendum does not break backwards compatibility. In this case none of the changes alter conformance requirements.

All changes were all managed via the GeoPackage GitHub repository. All substantive issues and most administrative issues were raised in the GitHub Issue Tracker and discussed by the SWG. Once the issue was resolved, a pull request was generated and merged into the repository. Some administrative issues such as typos were corrected directly through a commit on the master branch.

1.2. Document contributor contact points

All questions regarding this document should be directed to the editor or the contributors:

Table 1. Contacts
Name Organization

Jeff Yutzler

Image Matters

1.3. Future Work

No future work is planned to this document.

1.4. Foreword

Attention is drawn to the possibility that some of the elements of this document may be the subject of patent rights. The Open Geospatial Consortium shall not be held responsible for identifying any or all such patent rights.

Recipients of this document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of the standard set forth in this document, and to provide supporting documentation.

2. References

The following normative documents are referenced in this document.

NOTE: Only normative standards are referenced here, e.g. OGC, ISO or other SDO standards. All other references are listed in the bibliography.
  • OGC 12-128r15, OGC® GeoPackage Encoding Standard, version 1.2.1

3. Terms and definitions

For the purposes of this report, the definitions specified in Clause 4 of the OWS Common Implementation Standard [OGC 06-121r9] and in OGC® Abstract Specification Topic TBD: TBD shall apply. In addition, the following terms and definitions apply.

3.1. administrative change

An administrative change is a change that does not alter the abstract tests for any requirements. It includes typographical errors, changes in wording to improve clarity or consistency, and perfunctory changes like changes in version numbers.

3.2. critical Change

A critical change is a change that alters requirements in a way that is known to cause reverse compatibility issues.

3.3. substantive change

A substantive change is a change that alters requirements in a way that is not deemed to have a high risk for causing reverse compatibility issues.

3.4. Abbreviated terms

  • CITE Compliance, Interoperability, Testing, and Experimentation

  • CRS Coordinate Reference System

  • DDL Database Definition Language

  • GPKG GeoPackage

  • SQL Structured Query Language

  • SWG Standards Working Group

  • WKT Well Known Text

4. Change Log

4.1. KEY

  • Issue#: Issue in GitHub

  • PR#: Pull Request in GitHub (or commit number if no PR was made)

  • Type:

    • A=Administrative

    • S=Substantive

    • C=Critical

See Description of Critical Changes for more information on critical changes and Description of Substantive Changes for more information on substantive changes.

  • Section: Section number in the updated document

  • Description: Brief text describing the change

  • Purpose: the reason for the change, such as:

    • Clarity

    • Consistency

    • Interoperability

    • Perfunctory

    • Readability

    • Usability

4.2. Change Table

Table 2. Change Log
Issue# PR# Type Section Description Purpose

382

387

A

Annex F.8

Update DDL for gpkg_metadata table in "Hierarchical Metadata Example One - ISO19115"

Correctness

390

392

A

A.2.1.5.1., Annex F.1

Update incorrect table references to Annex G

Correctness

391

394

A

1.1.1.1.1

Link to limits.html on 140 TB limit

Clarity

395

396

A

multiple

Clarify "non null" constraint for views

Clarity

N/A

401

A

Annex F.3

Rewrite introduction to extension

Clarity

402

404

A

2.1.3.1.1

Clarify GeoPackageBinary 'X' bit

Clarity

N/A

404

A

Annex F.2, F.4, F.5

Providing links to deprecated extensions

Readability

407

408

A

2.2.1

Fix dangling reference

Consistency

414

415

S

Annex F.3

Remove erroneous part of trigger

Correctness

416

420

A

2.2.7.1.2

Clarify tile matrix numbering

Clarity

N/A

421, 422

A

Annex F.11

Update references to tiled gridded coverage extension

Perfunctory

N/A

427

A

Annex F.9

Update Table 19 to fix typos and improve clarity

Clarity

426

430

S

Annexes F.8, F.9, F.10

Update R140, R141, and R145 to indicate required rows and column values

Consistency

432

433

A

1.1.3.1.1

Clarify use of extents in gpkg_contents with tiles content

Clarity

436

440

A

multiple

Replace instances of GEOMCOLLECTION with GEOMETRYCOLLECTION

Consistency

437

439

A

Annexes F.1, F.6

Correcting incorrect ATS references

Correctness

N/A

441

A

Annex F.3

Remove ATS entry associated with removed requirement

Perfunctory

5. Description of Critical Changes

There are no critical changes in this release.

6. Description of Substantive Changes

6.1. Removing erroneous part of trigger (Annex F.3)

The update3 trigger for the RTree Spatial Index extension needs to have the “of ” portion struck. As originally written, the update3 trigger will only fire when the geometry is actually updated because of the “of ” clause – the key action this trigger is designed to handle is when the ID is changed – it can also deal with a geometry change at the same time – but as written will not fire if only the ID is changed.

This change does not introduce any risks to interoperability. However, by issuing this correction, we prevent an problem that could arise in the field and would be hard to debug. There have not been any reports of this problem in the field to date because most SQLite applications never change the internal id value of an existing row.

The executable test suite for GeoPackage has been updated to accept either the original or corrected version of the trigger for GeoPackage versions 1.2.0 and earlier. Versions 1.2.1 and later are required to use the corrected trigger.

6.1.1. Original Trigger

CREATE TRIGGER rtree_<t>_<c>_update3 AFTER UPDATE OF <c> ON <t>
  WHEN OLD.<i> != NEW.<i> AND
       (NEW.<c> NOTNULL AND NOT ST_IsEmpty(NEW.<c>))
BEGIN
  DELETE FROM rtree_<t>_<c> WHERE id = OLD.<i>;
  INSERT OR REPLACE INTO rtree_<t>_<c> VALUES (
    NEW.<i>,
    ST_MinX(NEW.<c>), ST_MaxX(NEW.<c>),
    ST_MinY(NEW.<c>), ST_MaxY(NEW.<c>)
  );
END;

6.1.2. Corrected Trigger

CREATE TRIGGER rtree_<t>_<c>_update3 AFTER UPDATE ON <t>
  WHEN OLD.<i> != NEW.<i> AND
       (NEW.<c> NOTNULL AND NOT ST_IsEmpty(NEW.<c>))
BEGIN
  DELETE FROM rtree_<t>_<c> WHERE id = OLD.<i>;
  INSERT OR REPLACE INTO rtree_<t>_<c> VALUES (
    NEW.<i>,
    ST_MinX(NEW.<c>), ST_MaxX(NEW.<c>),
    ST_MinY(NEW.<c>), ST_MaxY(NEW.<c>)
  );
END;

6.2. Updating R140, R141, and R145 to indicate required rows and column values (Annex F.8, F.9, and F.10)

One intent of the GeoPackage Encoding Standard was for GeoPackage contents (particularly tables) to be self-discoverable. Some tables are defined by the core standard, some tables are user defined (and therefore described by gpkg_contents), and some are added as part of extensions. In GeoPackage 1.2.0 and before, the way to describe tables added as part of extensions was not clearly specified. In the OGC GeoPackage Extension for Tiled Gridded Coverage Data, each required table is explicitly identified in the gpkg_extensions table. This change was made to apply this same technique consistently across extensions. This is a largely cosmetic change that will not have any impact on interoperability.

7. Future Work

There is no future work for this document being planned at this time. However, the GeoPackage SWG may wish to produce another version of the GeoPackage Encoding Standard if warranted.

Appendix A: Revision History

Table 3. Revision History
Date Release Editor Primary clauses modified Descriptions

April 13, 2018

J. Yutzler

.1

all

initial version

May 17, 2018

J. Yutzler

.9

4, 6

pre-release version