Skip to content

A NodeJS script to download all layers within a public or protected ArcGIS Online Feature or Map Service as GeoJSON.

License

Notifications You must be signed in to change notification settings

reyemtm/agol-cache

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

83 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ArcGIS Online Feature Service Layers to GeoJSON Multiple Formats

npx agol-cache serviceURL [FORMAT] TOKEN
npx agol-cache serviceURL gpkg TOKEN
npx agol-cache serviceURL TOKEN

The npx script will export all features to GeoJSON into an export folder in the current directory and prefix all files with export_. All other config options are set to their defaults. Additional format conversion options are available using gdal3.js - see formats.json. If exporting to anything other than GeoJSON, the original GeoJSON file will be deleted after successful conversion. Converting extremely large geojson files has not been tested...the conversion may fail due to memory constraints since it uses the original geojson file as input.


Download all layers from an ArcGIS Online Feature Service or Map Service to GeoJSON. The tool will attempt to identify the Esri OID field or one can be provided. More details on the background and functionality can be found in the link below.

Exporting AGOL Feature Services Using NodeJS and Batches to Transform an ArcGIS Online Feature Service to GeoJSON

const cache = require('agol-cache')

const url = 'https://services1.arcgis.com/fBc8EJBxQRMcHlei/ArcGIS/rest/services/NTF_Members_and_NR_Listings/FeatureServer/'

//can use async/aawit with layerByLayer: true

cache.featureServiceToGeoJSON(url, {
  attachments: false, //whether or not to check the service for attachments
  debug: false, //debugging is now on be default, which just means it writes to a log file, and the console logger is off if silent is set to false
  esriIdField: "", //field to use for the esriIdField, used in the query parameters, if NULL it is determined by the service response
  filter: "", //string to filter layer names
  folder: './geojson-cache', //folder to write the log file and geojson cache, relative to working directory or absolute path
  format: "json", //json or GeoJSON - json downloads the raw Esri JSON format then converts to GeoJSON (BETA), try this if using the GeoJSON endpoint fails
  layerByLayer: true, //THIS OPTION HAS BEEN REMOVED AND IS ALWAYS TRUE
  prefix: "test_", //prefix to add to the start of layer names
  silent: true, //turn off viewing winston log messages and spinner "info" messages in the console
  token: null //token to use for secured routes, taken from .env TOKEN variable,
  pretty: false, //if true, the JSON output file will be formatted for human reading
  timeout: 5000, //default is 5000, increase as needed
  steps: 1000 //number of features queried on each request
  outputFormat: "geojson" //for additional formats see lib/gdalVectorExtensions.js
  parseDomains: false,
  layers: true, //whether or not to download the layers as individual files - if false it skips all layers
  tables: true //whether or not to download the tables as individual files - if false it skips all tables
}, (layers) => {
  // console.log('output ' + layers.length + ' layers')
});

.env file example

TOKEN=validtokenstring

Changelog

Version 1.4.0

  • removed layerByLayer option
  • added tables option to download tables or skip
  • added layers option to download layers or skip
  • added gdal3.js for converting the output geojson to additional vector formats [BETA]
  • added parseDomains option to parse coded domains [BETA]
  • added pretty option to format the output GeoJSON file
  • added token option to add token in the config as well as the .env file

Version 1.2.4

  • added a boolean for parseDomains default false

Version 1.2.1

  • Failed exports are now deleted from disk.
  • Added supported for vector export formats using gdal3.js.

Version 1.2.0

  • Added npx functionality:
  • Added a decoder for coded domains based on the layer config field.domain.codedValues field.

Version 1.1.0

  • Added a function getAllServices.js that writes agol-services.json and agol-services.csv to the root folder containing all services for the given endpoint.
  • This function is a work in progress.
const { getAllServices } = require("./lib/getAllServices.js")

const config =   {
  debug: true,
  silent: true,
  timeout: 5000,
  token: ''
};

getAllServices('https://sampleserver6.arcgisonline.com/arcgis/rest/services', config)

Version 1.1.9

  • Added steps option to limit the amount of features queried on each fetch request, which defaults to 1000. Lower this number if you get timeouts from the REST service.

Version 1.0.2

  • Added an option to query the json endpoint and convert the data to GeoJSON once downloaded
  • Added small tweaks to the spinner options

Version 1.0.0

  • Added a config.timeout option to set the fetch timeout
  • Added support for large GeoJSON objects thanks a pull request from @jwoyame
  • Fixed a bug where not all the features would download due to large gaps in the sequential esriIdField

Version 0.9.0

  • fetch added back with additional fetch-retry dependency
  • timeout errors were issues on the Esri side and have been resolved
  • timeouts and attempts are set internally (5 second timeout, 5 attempts), adjust in the raw code as needed

Version 0.7.0

  • fetch replaced with axios and retry-axios due to timeout errors
  • fixed an issue where not all the features were downloaded

Version 0.6.1

  • added a filter option which will filter any layer that does not include the filter string

Version 0.6.0

  • added the ability to download Map Services
  • now attempts to find the esriFieldTypeOID field from the service definition
  • shortened the code to just keep querying the service at 1000 feature intervals until no more features are returned

Version 0.5.0

  • added an option to add a token in an environment variable
  • fixed a bug where if the folder did not exist the script would error out

Version 0.3.0

  • fixed an error where some features were downloaded twice
  • fixed an error where some features were not downloaded
  • added the ability to add a prefix to the downloaded files

Missing Features Needing External Work via Pull Requests

  • Working on the drawingInfo - renderer.
  • Add the ability to add query parameters.
  • Add an option to choose export format (JSON or GeoJSON)
  • Add the possibility to use a token for restricted services.

Helpful Commands

ogr2ogr -f MVT -dsco MINZOOM=10 -dsco MAXZOOM=14 target.mbtiles output/infile.geojson

TODO

  • Finish the test for gdal formats
  • Add tests for each helper function
  • Add test for getAllAttachments

About

A NodeJS script to download all layers within a public or protected ArcGIS Online Feature or Map Service as GeoJSON.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published