DOCSEARCHbyAlgolia
Submit Docs

ldproxy Documentation

website·Indexed 33 days ago

https://docs.ldproxy.net

Documentation for ldproxy, a platform for publishing geographic data via OGC API standards. It includes details on feature providers (SQL, GeoParquet, Oracle), tile providers (MVT, PNG), and building blocks for routing, transactions, and schema validation. The docs also cover deployment via OCI images, configuration using Redis and HTTP clients, and auxiliary tools like xtracfg, xtratiler, and the ldproxy VS Code extension.

Tokens
74.4K
Snippets
313
Records
566
Agent score
64%

What's inside ldproxy

  1. Overview of xtractl CLI

    xtractl is a command-line interface tool designed to control specific parts of a running ldproxy application that would otherwise require a full restart to modify. To ensure compatibility, the major version of xtractl must match the major version of the ldproxy instance being managed (e.g., use xtractl v3.x for ldproxy v3.6.4).

  2. Overview of xtracfg configuration tool

    xtracfg is a CLI tool used to check ldproxy configurations for deprecated options and errors, and to automatically upgrade configurations to the most recent version.

    Version Compatibility: The major version of xtracfg must match the major version of the ldproxy version being used. For example, if using ldproxy v3.6.4, use xtracfg v3.x. Configurations upgraded with xtracfg v3.x are compatible with both ldproxy v3.x and v4.x. Once you migrate to ldproxy v4.x, you must switch to xtracfg v4.x.

  3. Overview of the 3D Tile provider

    The 3D Tile provider generates 3D Tiles 1.1 in glTF format derived from a Feature Provider. It utilizes implicit quadtree tiling, with subtrees encoded in a binary format for compactness. The provider exclusively supports the ADD refinement strategy. To manage building representation across the tile hierarchy, use the contentFilters configuration to ensure each building is assigned to exactly one level.

  4. Overview of the Features building block for vector data

    The Features building block provides core capabilities for sharing vector data. By default, it supports GeoJSON and HTML encodings. Geometries are represented in the WGS 84 coordinate reference system (longitude/latitude axis order). The API supports response paging; if the result set exceeds the page size, a link to the next page is provided.

  5. Overview of the Routing building block

    The Routing building block is used to calculate and manage routes. It requires a PostgreSQL feature provider with the PostGIS and pgRouting extensions installed. It implements several OGC conformance classes, including 'Core', 'Manage Routes', 'Modes', 'Intermediate Waypoints', 'Height Restrictions', 'Weight Restrictions', 'Obstacles', and the 'Route Exchange Model'.

  6. Overview of the Tiles building block

    The Tiles building block enables the publication of geographic data as tiles. It supports tiles derived from feature data or tiles provided by an external source. Supported formats include MVT (Mapbox Vector Tile), PNG, WebP, JPEG, and TIFF. For tiles derived from feature data, only MVT is supported directly, or PNG map tiles derived from these vector tiles using MapLibre styles. All tiles within a single API are sourced from one tile provider.

  7. Overview of ldproxy geospatial API capabilities

    ldproxy provides modern web APIs to make geospatial data findable, accessible, interoperable, and reusable. It is a certified OGC Reference Implementation for OGC API - Features (Part 1: Core 1.0 and Part 2: Coordinate Reference Systems by Reference 1.0). Key capabilities include:

    • Standardized Formats: Supports GeoJSON, Mapbox Vector Tiles, Mapbox Styles, and TileJSON.
    • API Documentation: APIs are documented using OpenAPI 3.0.
    • Accessibility: Supports both JSON and HTML outputs, allowing for programmatic access or browser-based navigation.
    • Stability: Each data item is assigned a stable URI for external linking.

  8. Overview of xtracfg configuration tool

    xtracfg is a command-line utility used to manage configurations for xtraplatform applications, including ldproxy and XtraServer Web API. It provides functionality to check for configuration errors and upgrade deprecated settings or layouts.
    # Global options available to all xtracfg commands
-s, --src string      store source (default "./")
-d, --driver string   store source driver; currently the only option is FS (default "FS")
-v, --verbose         verbose output
--help                show help

  9. Overview of ldproxy Tile provider types

    ldproxy supports three types of Tile providers to source map tiles:

    1. Features: Tiles are derived from a feature provider.
    2. MbTiles: Tiles are retrieved from one or more MBTiles files.
    3. HTTP: Tiles are retrieved via HTTP (e.g., from a TileServer GL instance).

  10. Overview of 3D Tiles provider types

    LDProxy supports two types of 3D Tiles providers:

    1. Features: Tiles are derived from a feature provider.
    2. Files: Tiles are retrieved directly from the store.

  11. Overview of Feature Collections building block

    The Feature Collections building block must be enabled for every API with a feature provider. It provides the Feature Collections and Feature Collection resources and is currently the only supported type of collection. It implements the Core conformance class of the OGC API - Features - Part 1: Core 1.0.1 specification.

  12. Overview of ldproxy Feature Provider Extensions

    Feature Provider extensions provide support for specialized use cases not covered by core modules. Extensions are classified by their implementation maturity: 'mature' (stable and tested), 'candidate' (functional but may lack quality standards), and 'proposal' (stable core but may have limitations).

    Available extensions include:

    • Change Listener: Triggers feature change actions based on incremental changes in a PostgreSQL database.
    • JSON Schema Resolver: Derives schema definitions from external JSON schema files.
    • PostGIS Tiles: Provides optimized vector tile generation using PostGIS ST_AsMVT.
    • Routing: Provides support for pgRouting to compute routes.