v.in.wfs
Imports GetFeature from a WFS server.
v.in.wfs [-lr] url=string output=name [name=string [,string,...]] [layer=string [,string,...]] [srs=string] [maximum_features=integer] [start_index=integer] [version=string] [username=string] [password=string] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]
Example:
v.in.wfs url=string output=name
grass.script.run_command("v.in.wfs", url, output, name=None, layer=None, srs=None, maximum_features=None, start_index=None, version="1.0.0", username=None, password=None, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
gs.run_command("v.in.wfs", url="string", output="name")
grass.tools.Tools.v_in_wfs(url, output, name=None, layer=None, srs=None, maximum_features=None, start_index=None, version="1.0.0", username=None, password=None, flags=None, overwrite=None, verbose=None, quiet=None, superquiet=None)
Example:
tools = Tools()
tools.v_in_wfs(url="string", output="name")
This grass.tools API is experimental in version 8.5 and expected to be stable in version 8.6.
Parameters
url=string [required]
Base URL starting with 'http' and ending in '?'
output=name [required]
Name for output vector map
name=string [,string,...]
Comma separated names of data layers to download
layer=string [,string,...]
Name of data layers to import
srs=string
Specify alternate spatial reference system (example: EPSG:4326)
The given code must be supported by the server, consult the capabilities file
maximum_features=integer
Maximum number of features to download
(default: unlimited)
start_index=integer
Skip earlier feature IDs and start downloading at this one
(default: start with the first feature)
version=string
version of WFS, e.g.:1.0.0 or 2.0.0
Default: 1.0.0
username=string
Username or file with username or environment variable name with username
password=string
Password or file with password or environment variable name with password
-l
Download server capabilities to 'wms_capabilities.xml' in the current directory and exit
-r
Restrict fetch to features which touch the current region
--overwrite
Allow output files to overwrite existing files
--help
Print usage summary
--verbose
Verbose module output
--quiet
Quiet module output
--qq
Very quiet module output
--ui
Force launching GUI dialog
url : str, required
Base URL starting with 'http' and ending in '?'
output : str, required
Name for output vector map
Used as: output, vector, name
name : str | list[str], optional
Comma separated names of data layers to download
layer : str | list[str], optional
Name of data layers to import
srs : str, optional
Specify alternate spatial reference system (example: EPSG:4326)
The given code must be supported by the server, consult the capabilities file
maximum_features : int, optional
Maximum number of features to download
(default: unlimited)
start_index : int, optional
Skip earlier feature IDs and start downloading at this one
(default: start with the first feature)
version : str, optional
version of WFS, e.g.:1.0.0 or 2.0.0
Default: 1.0.0
username : str, optional
Username or file with username or environment variable name with username
password : str, optional
Password or file with password or environment variable name with password
flags : str, optional
Allowed values: l, r
l
Download server capabilities to 'wms_capabilities.xml' in the current directory and exit
r
Restrict fetch to features which touch the current region
overwrite : bool, optional
Allow output files to overwrite existing files
Default: None
verbose : bool, optional
Verbose module output
Default: None
quiet : bool, optional
Quiet module output
Default: None
superquiet : bool, optional
Very quiet module output
Default: None
url : str, required
Base URL starting with 'http' and ending in '?'
output : str, required
Name for output vector map
Used as: output, vector, name
name : str | list[str], optional
Comma separated names of data layers to download
layer : str | list[str], optional
Name of data layers to import
srs : str, optional
Specify alternate spatial reference system (example: EPSG:4326)
The given code must be supported by the server, consult the capabilities file
maximum_features : int, optional
Maximum number of features to download
(default: unlimited)
start_index : int, optional
Skip earlier feature IDs and start downloading at this one
(default: start with the first feature)
version : str, optional
version of WFS, e.g.:1.0.0 or 2.0.0
Default: 1.0.0
username : str, optional
Username or file with username or environment variable name with username
password : str, optional
Password or file with password or environment variable name with password
flags : str, optional
Allowed values: l, r
l
Download server capabilities to 'wms_capabilities.xml' in the current directory and exit
r
Restrict fetch to features which touch the current region
overwrite : bool, optional
Allow output files to overwrite existing files
Default: None
verbose : bool, optional
Verbose module output
Default: None
quiet : bool, optional
Quiet module output
Default: None
superquiet : bool, optional
Very quiet module output
Default: None
Returns:
result : grass.tools.support.ToolResult | None
If the tool produces text as standard output, a ToolResult object will be returned. Otherwise, None
will be returned.
DESCRIPTION
v.in.wfs imports OGC WFS maps (Web Feature Service) from external servers.
EXAMPLES
WFS import without credentials
Import of Copernicus Sentinel-2 satellite scene footprints:
# run in Latitude-Longitude project (EPGS code 4326):
# download "sentinel:mgrs" layer:
v.in.wfs url="https://geoserver.mundialis.de/geoserver/sentinel/wfs?" name="sentinel:mgrs" output=sentinel2_mgrs
# download NRW ALKIS "ave:Flurstueck" attribute:
# set the AOI beforehand with g.region and limit import to current region with -r flag
v.in.wfs url="https://www.wfs.nrw.de/geobasis/wfs_nw_alkis_vereinfacht?" -r output=wfs_alkis_vereinfacht srs=25832
name="ave:Flurstueck" version="2.0.0" layer="Flurstueck"
WFS import with API key
Download 25 ship wrecks from LINZ data service:
(first create yourself a free API key at
http://data.linz.govt.nz/p/web-services/)
# run in LatLong project:
URL='http://wfs.data.linz.govt.nz/<PUT YOUR API KEY HERE>/wfs?'
# download list of available layers to wms_capabilities.xml
v.in.wfs -l url="$URL"
From that file we learn that the shipwreck layer is called "v:x633
"
and that EPSG code 4326 (LatLong WGS84) is a supported SRS for this data
layer.
v.in.wfs url="$URL" output=linz_hydro_25_wrecks name="v:x633" srs="EPSG:4326" max=25
REQUIREMENTS
The OGR library on the system needs to be compiled with Xerces C++ XML Parser support (for GML).
SEE ALSO
g.region, r.in.wms, v.import, v.in.ogr
AUTHORS
Markus Neteler, Hamish Bowman
SOURCE CODE
Available at: v.in.wfs source code
(history)
Latest change: Monday Feb 10 14:42:02 2025 in commit 5fe1b99