qgis_createattributeindex: QGIS algorithm - Create attribute index

View source: R/qgis_createattributeindex.R

qgis_createattributeindexR Documentation

QGIS algorithm - Create attribute index

Description

QGIS Algorithm provided by QGIS (native c++) Create attribute index (native:createattributeindex). Creates an index to speed up queries made against a field in a table. Support for index creation is dependent on the layer's data provider and the field type.

Usage

qgis_createattributeindex(
  INPUT = qgisprocess:::qgis_default_value(),
  FIELD = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

vector - Input layer. Path to a vector layer.

FIELD

field - Attribute to index. The name of an existing field. ; delimited list of existing field names.

...

further parameters passed to qgisprocess::qgis_run_algorithm()

.complete_output

logical specifying if complete out of qgisprocess::qgis_run_algorithm() should be used (TRUE) or first output (most likely the main) should read (FALSE). Default value is TRUE.

.quiet

logical specifying if parameter .quiet for qgisprocess::qgis_run_algorithm() Default value is TRUE.

.messages

logical specifying if messages from qgisprocess::qgis_run_algorithm() should be printed (TRUE) or not (FALSE). Default value is FALSE.

Details

Outputs description

  • OUTPUT - outputVector - Indexed layer


JanCaha/r_package_qgis documentation built on April 4, 2024, 8:10 p.m.