qgis_importintopostgis: QGIS algorithm - Export to PostgreSQL

View source: R/qgis_importintopostgis.R

qgis_importintopostgisR Documentation

QGIS algorithm - Export to PostgreSQL

Description

QGIS Algorithm provided by QGIS (native c++) Export to PostgreSQL (native:importintopostgis). Exports a vector layer to a PostgreSQL database This algorithm exports a vector layer to a PostgreSQL database, creating a new table. Prior to this a connection between QGIS and the PostgreSQL database has to be created (for example through the QGIS Browser panel).

Usage

qgis_importintopostgis(
  INPUT = qgisprocess:::qgis_default_value(),
  DATABASE = qgisprocess:::qgis_default_value(),
  SCHEMA = qgisprocess:::qgis_default_value(),
  TABLENAME = qgisprocess:::qgis_default_value(),
  PRIMARY_KEY = qgisprocess:::qgis_default_value(),
  GEOMETRY_COLUMN = qgisprocess:::qgis_default_value(),
  ENCODING = qgisprocess:::qgis_default_value(),
  OVERWRITE = qgisprocess:::qgis_default_value(),
  CREATEINDEX = qgisprocess:::qgis_default_value(),
  LOWERCASE_NAMES = qgisprocess:::qgis_default_value(),
  DROP_STRING_LENGTH = qgisprocess:::qgis_default_value(),
  FORCE_SINGLEPART = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

source - Layer to export. Path to a vector layer.

DATABASE

providerconnection - Database (connection name). Name of registered database connection.

SCHEMA

databaseschema - Schema (schema name). Name of existing database schema.

TABLENAME

databasetable - Table to export to (leave blank to use layer name). Name of existing database table.

PRIMARY_KEY

field - Primary key field. The name of an existing field. ; delimited list of existing field names.

GEOMETRY_COLUMN

string - Geometry column. 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.

ENCODING

string - Encoding. 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.

OVERWRITE

boolean - Overwrite. 1 for true/yes. 0 for false/no. 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.

CREATEINDEX

boolean - Create spatial index. 1 for true/yes. 0 for false/no. 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.

LOWERCASE_NAMES

boolean - Convert field names to lowercase. 1 for true/yes. 0 for false/no. 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.

DROP_STRING_LENGTH

boolean - Drop length constraints on character fields. 1 for true/yes. 0 for false/no. 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.

FORCE_SINGLEPART

boolean - Create single-part geometries instead of multipart. 1 for true/yes. 0 for false/no. 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.

...

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

No output description provided.


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