new_join_dataset#

geodesic.boson.dataset.new_join_dataset(name, left_dataset, right_dataset, left_field=None, right_field=None, spatial_join=False, left_drop_fields=[], right_drop_fields=[], left_suffix='_left', right_suffix='_right', use_geometry='right', skip_initialize=False, feature_limit=1000, max_left_page_queries=10, right_collection=None, left_collection=None, project=None, middleware={}, cache={}, tile_options={}, domain='*', category='*', type='*', **kwargs)[source]#

Creates a left join of two feature datasets on the values of specific keys.

Currently this is intended for smaller datasets or used in conjuction with the view provider to limit the scope of the join.

Parameters:

  • name (str) – the name of the new Dataset

  • left_dataset (Dataset) – the left dataset to join

  • left_field (str | None) – the field in the left dataset to join on

  • right_dataset (Dataset) – the right dataset to join

  • right_field (str | None) – the field in the right dataset to join on

  • spatial_join (bool) – if True, will perform a spatial join

  • left_drop_fields (List[str]) – fields to drop from the left dataset

  • right_drop_fields (List[str]) – fields to drop from the right dataset

  • left_suffix (str) – the suffix to add to the left dataset fields

  • right_suffix (str) – the suffix to add to the right dataset fields

  • use_geometry (str) – which geometry to use, either ‘left’ or ‘right’

  • skip_initialize (bool) – if True, will not initialize the right provider. This is necessary if the right provider is particularly large - all joins will then be dynamic.

  • feature_limit (int) – the max size of a results page from a query/search

  • max_left_page_queries (int) – the max number of queries a single join request will make to the left provider. The default is 10. This limit is in place to prevent inefficient join requests. Before adjusting this, consider increasing the max page size of the left provider.

  • right_collection (str | None) – if the right dataset has multiple collections, the name of the collection to use.

  • left_collection (str | None) – if the left dataset has multiple collections, the name of the collection to use.

  • project (Project | str | None) – the name of the project this will be assigned to

  • middleware (MiddlewareConfig) – configure any boson middleware to be applied to the new dataset.

  • cache (CacheConfig) – configure caching for this dataset

  • tile_options (TileOptions) – configure tile options for this dataset

  • domain (str) – the domain of the dataset

  • category (str) – the category of the dataset

  • type (str) – the type of the dataset

  • **kwargs (dict) – additional properties to set on the new dataset

On this page

This Page