Publication Date: 2017-mm-dd

Approval Date: 2017-mm-dd

Posted Date: 2017-xx-xx

Reference number of this document: OGC 16-126

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


Revision Notes

COPYRIGHT

Copyright © 2016 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 (OGC 12-128r13) 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 2016, the GeoPackage Standards Working Group (SWG) made a number of changes to the GeoPackage Encoding Standard Version 1.1 (OGC 12-128r12). These changes have been aggregated into version 1.2 of the GeoPackage Encoding Standard (12-128r13).

GeoPackage 1.2 is a minor revision to version 1.1. The minor revision designation is being used because of a number of substantive changes that alter conformance requirements. However, all of these changes were carefully considered for impact on existing implementations. Changes that were considered to have a significant impact were rejected or recast in order to limit their impact.

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.

A large number of the changes in this version were initiated through official change requests. In addition, a new extension was added as a result of the GeoPackage Elevation Extension Interoperability Experiment (see [B1]).

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-128r13, OGC® GeoPackage Encoding Standard, version 1.2

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

209

A

1.1.1.1.1

Clarify that GeoPackage header is null-terminated

Clarity

213

227

A

Annex B.2

Add new terms and definitions

Clarity

214

219

A

Annex B.11-13

Update UML diagrams to show DATETIME where appropriate

Consistency

221

251

S

2.4

Adding "attributes" section to describe use of non-spatial data

Addition

222

224

A

1.1.3

Rewrite description of gpkg_contents table

Clarity

228

240

A

Annex F.8

Simplify triggers to avoid failures on row-level entries

Usability

231

236

A

Annex F.9

Correct wording in Table #42

Clarity

234

239

S

Annex F.1

Deprecate Requirement #69

Usability

235

239

S

Annex F.2,4,5

Deprecate extensions F.2, F.4, F.5

Interoperability

237

236

A

2.2.7.1.2

Rewrite Requirement #53

Clarity

238

236

A

Various

Typography

Readability

241

244

A

2.3.2.1.1

Update description for definition column

Usability

242, 257

248, et. al.

S

F.11-12

Add Elevation extension to standard

Addition

243

A

F.8

Add default to SQL DDL

Consistency

245

267

A

Annex B.5-6

Change Log

Perfunctory

249

259

A

Various

Typography

Readability

254

268

A

2.3.2.1.1

Updating rules for extensions in Requirement 58

Clarity

255, 266

264, 273

S

1.1.1.1.1, Annex A

Update versioning mechanism, allow for version increments in SQLite header

Interoperability

258

236

S

Annex F.10

Correct column name for CRS WKT Extension

Consistency

260

263

A

Annex F.9

Correct min/max_is_inclusive in abstract tests

Consistency

261

264

A

1.1.1.1.2

Eliminate .gpkx option

Usability

N/A

269

A

2.2.6.1.2

Typography

Readability

5. Description of Critical Changes

There are no critical changes in this release.

6. Description of Substantive Changes

6.1. 221 Adding Attributes Section

A strict read of GeoPackage v1.1 does not allow non-spatial attribute values. However, in practice data providers routinely need to deliver data that does not contain geometry properties. Requiring any GeoPackage that contains non-spatial tables to be declared and documented as an "Extended GeoPackage" is not reasonable and does not promote interoperability. Therefore, the specification has been modified to allow non-spatial attribute tables in a basic GeoPackage. This change is considered to be low-risk because it creates a new encoding option that would be ignored by previous versions of the standard.

6.2. 234 Deprecate Requirement #69

It was determined that it is difficult, if not impossible, to comply with Req 69 "SQL functions that operate on GeoPackageBinary geometries as specified in other extensions SHALL operate correctly on the non-linear geometries specified in this extension." because the functions could have been loaded via an extension such SpatiaLite which cannot be changed, and does not support the non-linear geometries. The removal of this requirement will allow for interoperable storage and retrieval of the geometries, while not requiring but allowing existing functions to work with the geometries.

6.3. 235 Deprecate Extensions F.2, F.4, and F.5

The GeoPackage SWG agreed to remove the “User Defined Geometry Types Extension of GeoPackageBinary Geometry Encoding” extension from the encoding standard for the following reasons:

  • The geometry encoding is not specified in the extension and therefore a supplemental document explaining the encoding would be required. In the absence of this document, there is no way for an application developer to support this extension and therefore it is not interoperable.

  • Multiple developers could implement the encoding of a new, but similar geometry type such as EllipiticalCurve in different ways.

  • Existing spatial functions will not work with the new geometry types and could potentially cause errors or skip data if used.

The SWG also agreed to remove two addition extensions, “Geometry Type Triggers” and “Geometry SRS ID Triggers”, from the encoding standard as they directly relate to User-Defined Geometry Types Extension and will no longer be required.

The SWG believes that content contained in these extensions would be better suited in a best practice document. This document could outline how to create a complete and interoperable User Defined Geometry Type Extension, including the details of the geometry encoding and how it can be used with existing spatial functions. This would allow two independent developers to create User-Defined Geometry Type extensions that follow the same template and make it easier for clients of the extensions to adopt.

6.4. 242 Add Elevation Extension to Standard

After successful completion of the GeoPackage Elevation Extension Interoperability Experiment (see [B1]), the SWG agreed to add a new extension to the standard. The "Tiled Gridded Elevation Data" extension stores tiled gridded elevation data in a GeoPackage. The tiles contain elevation values and may be 16-bit PNG files or 32-bit TIFF files. The extension defines two ancillary data tables, one for coverages and one for tiles. When using the PNG encoding, a scale and offset may be applied. The extension also allows for a TIFF encoding but it constrains many of the TIFF options that are available to simplify development.

6.5. 255 Update versioning mechanism, allow for version increments in SQLite header

In GeoPackage 1.1 and earlier, Requirement 2 specifies an exact string as the application identifier. This string is also supposed to be added to SQLite’s magic.txt file ([B3]). The SWG determined that updating this file is unsustainable. Instead, GeoPackage will now use the original application ID (GPKG) and use the user_version header to indicate the version. In addition, it is reasonable to for clients designed to comply with a specific version of the standard to interoperate with GeoPackages that comply with a later version. In response, Requirement 2 was reworded to allow for version increments and the associated abstract test was updated. This change should improve interoperability as well as make it more reasonable for GeoPackage producers to pass CITE tests.

6.6. 258 Column Name for WKT for Coordinate Reference Systems

The “WKT for Coordinate Reference Systems” extension was designed to align to a new OGC Encoding Standard, OGC 12-063r5 (see [B2]). The text in GPKG 1.1 (including the column name) incorrectly references “12-163” instead. This change corrects all references to the proper “12-063”. The GeoPackage SWG regrets the error. This change is considered to be low-risk. At worst, implementers may need to populate a redundant column to satisfy clients that use this extension but only support GPKG 1.1.

7. Future Work

7.1. Multi-resolution Vector Data (220)

An approach has been developed for storing geometries for multiple resolutions. However, it was determined to be premature to add this approach to the standard as an extension. It is being considered for OGC Testbed 13.

7.2. Breaking Changes

Changes that were considered to be "breaking" or had great risk to interoperability were rejected for this release. These issues may be found in GitHub at https://github.com/opengeospatial/geopackage/milestone/11.

  • 229: Inconsistent naming gpkg_contents(identifier) / gpkg_data_columns (name)

  • 230: gpkg_contents should have title column

Appendix A: Revision History

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

August 30, 2016

J. Yutzler

.1

all

initial version

October 16, 2016

J. Yutzler

.2

all

migration to Asciidoc

October 18, 2016

J. Yutzler

.3

3, 4, 6

feedback from 10/17 SWG

October 19, 2016

J. Yutzler

.4

0, 1, 4

review

December 13, 2016

J. Yutzler

.5

4, 6

late additions

Appendix B: Bibliography

[B1] OGC GeoPackage Elevation Extension Interoperability Report, OGC 16-094r3. (2016).

[B2] Well-known text representation of coordinate reference systems, version 1.0, OGC 12-063r5. (2015).

[B3] SQLite magic.txt, http://www.sqlite.org/src/artifact/8273bf49ba3b0c85, June 16, 2014.