API reference

Core

pyogrio.get_gdal_config_option(name)

Get the value for a GDAL configuration option.

Parameters
namestr

name of the option to retrive

Returns
value of the option or None if not set

'ON' / 'OFF' are normalized to True / False.

pyogrio.list_drivers(read=False, write=False)

List drivers available in GDAL.

Parameters
read: bool, optional (default: False)

If True, will only return drivers that are known to support read capabilities.

write: bool, optional (default: False)

If True, will only return drivers that are known to support write capabilities.

Returns
dict

Mapping of driver name to file mode capabilities: "r": read, "w": write. Drivers that are available but with unknown support are marked with "?"

pyogrio.list_layers(path_or_buffer, /)

List layers available in an OGR data source.

NOTE: includes both spatial and nonspatial layers.

Parameters
pathstr or pathlib.Path
Returns
ndarray shape (2, n)

array of pairs of [<layer name>, <layer geometry type>] Note: geometry is None for nonspatial layers.

pyogrio.read_bounds(path_or_buffer, /, layer=None, skip_features=0, max_features=None, where=None, bbox=None)

Read bounds of each feature.

This can be used to assist with spatial indexing and partitioning, in order to avoid reading all features into memory. It is roughly 2-3x faster than reading the full geometry and attributes of a dataset.

Parameters
pathpathlib.Path or str

data source path

layerint or str, optional (default: first layer)

If an integer is provided, it corresponds to the index of the layer with the data source. If a string is provided, it must match the name of the layer in the data source. Defaults to first layer in data source.

skip_featuresint, optional (default: 0)

Number of features to skip from the beginning of the file before returning features. Must be less than the total number of features in the file.

max_featuresint, optional (default: None)

Number of features to read from the file. Must be less than the total number of features in the file minus skip_features (if used).

wherestr, optional (default: None)

Where clause to filter features in layer by attribute values. Uses a restricted form of SQL WHERE clause, defined here: http://ogdi.sourceforge.net/prop/6.2.CapabilitiesMetadata.html Examples: "ISO_A3 = 'CAN'", "POP_EST > 10000000 AND POP_EST < 100000000"

bboxtuple of (xmin, ymin, xmax, ymax), optional (default: None)

If present, will be used to filter records whose geometry intersects this box. This must be in the same CRS as the dataset.

Returns
tuple of (fids, bounds)

fids are global IDs read from the FID field of the dataset bounds are ndarray of shape(4, n) containing xmin, ymin, xmax, ymax

pyogrio.read_info(path_or_buffer, /, layer=None, encoding=None)

Read information about an OGR data source.

crs and geometry will be None and features will be 0 for a nonspatial layer.

Parameters
pathstr or pathlib.Path
layer[type], optional

Name or index of layer in data source. Reads the first layer by default.

encoding[type], optional (default: None)

If present, will be used as the encoding for reading string values from the data source, unless encoding can be inferred directly from the data source.

Returns
dict

A dictionary with the following keys:

{
    "crs": "<crs>",
    "fields": <ndarray of field names>,
    "dtypes": <ndarray of field dtypes>,
    "encoding": "<encoding>",
    "geometry": "<geometry type>",
    "features": <feature count>
}
pyogrio.set_gdal_config_options(options)

Set GDAL configuration options.

Options are listed here: https://trac.osgeo.org/gdal/wiki/ConfigOptions

No error is raised if invalid option names are provided.

These options are applied for an entire session rather than for individual functions.

Parameters
optionsdict

If present, provides a mapping of option name / value pairs for GDAL configuration options. True / False are normalized to 'ON' / 'OFF'. A value of None for a config option can be used to clear out a previously set value.

GeoPandas integration

pyogrio.read_dataframe(path_or_buffer, /, layer=None, encoding=None, columns=None, read_geometry=True, force_2d=False, skip_features=0, max_features=None, where=None, bbox=None, fids=None, sql=None, sql_dialect=None, fid_as_index=False)

Read from an OGR data source to a GeoPandas GeoDataFrame or Pandas DataFrame. If the data source does not have a geometry column or read_geometry is False, a DataFrame will be returned.

Requires geopandas >= 0.8.

Parameters
path_or_bufferpathlib.Path or str, or bytes buffer

A dataset path or URI, or raw buffer.

layerint or str, optional (default: first layer)

If an integer is provided, it corresponds to the index of the layer with the data source. If a string is provided, it must match the name of the layer in the data source. Defaults to first layer in data source.

encodingstr, optional (default: None)

If present, will be used as the encoding for reading string values from the data source, unless encoding can be inferred directly from the data source.

columnslist-like, optional (default: all columns)

List of column names to import from the data source. Column names must exactly match the names in the data source, and will be returned in the order they occur in the data source. To avoid reading any columns, pass an empty list-like.

read_geometrybool, optional (default: True)

If True, will read geometry into a GeoSeries. If False, a Pandas DataFrame will be returned instead.

force_2dbool, optional (default: False)

If the geometry has Z values, setting this to True will cause those to be ignored and 2D geometries to be returned

skip_featuresint, optional (default: 0)

Number of features to skip from the beginning of the file before returning features. Must be less than the total number of features in the file.

max_featuresint, optional (default: None)

Number of features to read from the file. Must be less than the total number of features in the file minus skip_features (if used).

wherestr, optional (default: None)

Where clause to filter features in layer by attribute values. Uses a restricted form of SQL WHERE clause, defined here: http://ogdi.sourceforge.net/prop/6.2.CapabilitiesMetadata.html Examples: "ISO_A3 = 'CAN'", "POP_EST > 10000000 AND POP_EST < 100000000"

bboxtuple of (xmin, ymin, xmax, ymax) (default: None)

If present, will be used to filter records whose geometry intersects this box. This must be in the same CRS as the dataset.

fidsarray-like, optional (default: None)

Array of integer feature id (FID) values to select. Cannot be combined with other keywords to select a subset (skip_features, max_features, where, bbox or sql). Note that the starting index is driver and file specific (e.g. typically 0 for Shapefile and 1 for GeoPackage, but can still depend on the specific file). The performance of reading a large number of features usings FIDs is also driver specific.

sqlstr, optional (default: None)

The sql statement to execute. Look at the sql_dialect parameter for more information on the syntax to use for the query. When combined with other keywords like columns, skip_features, max_features, where or bbox, those are applied after the sql query. Be aware that this can have an impact on performance, (e.g. filtering with the bbox keyword may not use spatial indexes). Cannot be combined with the layer or fids keywords.

sql_dialectstr, optional (default: None)

The sql dialect the sql statement is written in. Possible values:

  • None: if the datasource natively supports sql, the specific sql syntax for this datasource should be used (eg. SQLite, PostgreSQL, Oracle,…). If the datasource doesn’t natively support sql, the ‘OGRSQL’ dialect is the default.

  • OGRSQL’: can be used on any datasource. Performance can suffer when used on datasources with native support for sql.

  • SQLITE’: can be used on any datasource. All spatialite functions can be used. Performance can suffer on datasources with native support for sql, except for GPKG and SQLite as this is their native sql dialect.

fid_as_indexbool, optional (default: False)

If True, will use the FIDs of the features that were read as the index of the GeoDataFrame. May start at 0 or 1 depending on the driver.

Returns
GeoDataFrame or DataFrame (if no geometry is present)
pyogrio.write_dataframe(df, path, layer=None, driver=None, encoding=None, geometry_type=None, promote_to_multi=None, **kwargs)

Write GeoPandas GeoDataFrame to an OGR file format.

Parameters
dfGeoDataFrame

The data to write. For attribute columns of the “object” dtype, all values will be converted to strings to be written to the output file, except None and np.nan, which will be set to NULL in the output file.

pathstr

path to file

layer :str, optional (default: None)

layer name

driverstring, optional (default: None)

The OGR format driver used to write the vector file. By default write_dataframe attempts to infer driver from path.

encodingstr, optional (default: None)

If present, will be used as the encoding for writing string values to the file.

geometry_typestring, optional (default: None)

By default, the geometry type of the layer will be inferred from the data, after applying the promote_to_multi logic. If the data only contains a single geometry type (after applying the logic of promote_to_multi), this type is used for the layer. If the data (still) contains mixed geometry types, the output layer geometry type will be set to “Unknown”.

This parameter does not modify the geometry, but it will try to force the layer type of the output file to this value. Use this parameter with caution because using a non-default layer geometry type may result in errors when writing the file, may be ignored by the driver, or may result in invalid files. Possible values are: “Unknown”, “Point”, “LineString”, “Polygon”, “MultiPoint”, “MultiLineString”, “MultiPolygon” or “GeometryCollection”.

promote_to_multibool, optional (default: None)

If True, will convert singular geometry types in the data to their corresponding multi geometry type for writing. By default, will convert mixed singular and multi geometry types to multi geometry types for drivers that do not support mixed singular and multi geometry types. If False, geometry types will not be promoted, which may result in errors or invalid files when attempting to write mixed singular and multi geometry types to drivers that do not support such combinations.

**kwargs

The kwargs passed to OGR.