gdal_executesql: QGIS algorithm - Execute SQL

View source: R/gdal_executesql.R

gdal_executesqlR Documentation

QGIS algorithm - Execute SQL

Description

QGIS Algorithm provided by GDAL Execute SQL (gdal:executesql). —————- Arguments —————- INPUT: Input layer Argument type: source Acceptable values: - Path to a vector layer SQL: SQL expression Default value: Argument type: string Acceptable values: - String value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression DIALECT: SQL dialect Default value: 0 Argument type: enum Available values: - 0: None - 1: OGR SQL - 2: SQLite Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' OPTIONS: Additional creation options (optional) Default value: Argument type: string Acceptable values: - String value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression OUTPUT: SQL result Argument type: vectorDestination Acceptable values: - Path for new vector layer

Usage

gdal_executesql(
  INPUT = qgisprocess:::qgis_default_value(),
  SQL = qgisprocess:::qgis_default_value(),
  DIALECT = qgisprocess:::qgis_default_value(),
  OPTIONS = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

source - Input layer. Path to a vector layer.

SQL

string - SQL expression. String value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

DIALECT

enum of ⁠("None", "OGR SQL", "SQLite")⁠ - SQL dialect. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

OPTIONS

string - Additional creation options. String value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

OUTPUT

vectorDestination - SQL result. Path for new vector layer.

...

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 - SQL result


JanCaha/r_package_qgis documentation built on Nov. 3, 2024, 5:25 p.m.