% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ddbs_geom_conversion.R
\name{ddbs_geom_from}
\alias{ddbs_geom_from}
\alias{ddbs_geom_from_text}
\alias{ddbs_geom_from_wkb}
\alias{ddbs_geom_from_hexwkb}
\alias{ddbs_geom_from_hexewkb}
\alias{ddbs_geom_from_geojson}
\title{Create geometries from standard interchange formats}
\usage{
ddbs_geom_from_text(
  x,
  crs = NULL,
  ...,
  geom_col = "geometry",
  conn = NULL,
  name = NULL,
  mode = NULL,
  overwrite = FALSE,
  quiet = FALSE
)

ddbs_geom_from_wkb(
  x,
  crs = NULL,
  ...,
  geom_col = "geometry",
  conn = NULL,
  name = NULL,
  mode = NULL,
  overwrite = FALSE,
  quiet = FALSE
)

ddbs_geom_from_hexwkb(
  x,
  crs = NULL,
  ...,
  geom_col = "geometry",
  conn = NULL,
  name = NULL,
  mode = NULL,
  overwrite = FALSE,
  quiet = FALSE
)

ddbs_geom_from_hexewkb(
  x,
  crs = NULL,
  ...,
  geom_col = "geometry",
  conn = NULL,
  name = NULL,
  mode = NULL,
  overwrite = FALSE,
  quiet = FALSE
)

ddbs_geom_from_geojson(
  x,
  crs = NULL,
  ...,
  geom_col = "geometry",
  conn = NULL,
  name = NULL,
  mode = NULL,
  overwrite = FALSE,
  quiet = FALSE
)
}
\arguments{
\item{x}{For \code{ddbs_geom_from_wkb()}, a list of raw vectors (binary WKB). For
all other functions, a character vector of serialized geometries.}

\item{crs}{Character or numeric CRS specification (e.g. \code{"EPSG:4326"} or
\code{4326}) to assign to the resulting geometries. Defaults to \code{NULL} (no CRS
assigned).}

\item{...}{Named vectors of additional attribute columns to include in the
output. Each must have the same length as \code{x}.}

\item{geom_col}{Name of the geometry column in the output. Defaults to
\code{"geometry"}.}

\item{conn}{A connection object to a DuckDB database. If \code{NULL}, the function
runs on a temporary DuckDB database.}

\item{name}{A character string of length one specifying the name of the table,
or a character string of length two specifying the schema and table
names. If \code{NULL} (the default), the function returns the result as an
\code{sf} object}

\item{mode}{Character. Controls the return type. Options:
\itemize{
\item \code{"duckspatial"} (default): Lazy spatial data frame backed by dbplyr/DuckDB
\item \code{"sf"}: Eagerly collected sf object (uses memory)
}
Can be set globally via \code{\link{ddbs_options}(mode = "...")} or
per-function via this argument. Per-function overrides global setting.}

\item{overwrite}{Boolean. whether to overwrite the existing table if it exists. Defaults
to \code{FALSE}. This argument is ignored when \code{name} is \code{NULL}.}

\item{quiet}{A logical value. If \code{TRUE}, suppresses any informational messages.
Defaults to \code{FALSE}.}
}
\value{
Depends on the \code{mode} argument (or global preference set by \code{\link{ddbs_options}}):
\itemize{
\item \code{duckspatial} (default): A \code{duckspatial_df} (lazy spatial data frame) backed by dbplyr/DuckDB.
\item \code{sf}: An eagerly collected object in R memory, that will return the same data type as the
\code{sf} equivalent (e.g. \code{sf} or \code{units} vector).
}
When \code{name} is provided, the result is also written as a table or view in DuckDB and the function returns \code{TRUE} (invisibly).
}
\description{
Parse serialized geometries from common interchange formats into a spatial
object, using DuckDB spatial deserialization functions. These are the
inverses of the \code{\link[=ddbs_as_text]{ddbs_as_text()}} / \code{\link[=ddbs_as_wkb]{ddbs_as_wkb()}} / \code{\link[=ddbs_as_hexwkb]{ddbs_as_hexwkb()}} /
\code{\link[=ddbs_as_geojson]{ddbs_as_geojson()}} serializers.
\itemize{
\item \code{ddbs_geom_from_text()} – Parse Well-Known Text (WKT)
\item \code{ddbs_geom_from_wkb()} – Parse Well-Known Binary (WKB)
\item \code{ddbs_geom_from_hexwkb()} – Parse hexadecimal Well-Known Binary (HEXWKB)
\item \code{ddbs_geom_from_hexewkb()} – Parse hexadecimal Extended Well-Known Binary (HEXEWKB)
\item \code{ddbs_geom_from_geojson()} – Parse GeoJSON
}
}
\details{
These functions are thin wrappers around the DuckDB spatial deserialization
functions (\code{ST_GeomFromText}, \code{ST_GeomFromWKB}, \code{ST_GeomFromHEXWKB},
\code{ST_GeomFromHEXEWKB}, and \code{ST_GeomFromGeoJSON}).

They are useful for importing geometries produced by external spatial tools,
databases, and web services back into a \code{duckspatial} workflow.
}
\examples{
\dontrun{
library(duckspatial)

## from WKT
ddbs_geom_from_text(
  c("POINT (-58.38 -34.60)", "POINT (-64.18 -31.42)"),
  crs = 4326
)

## from GeoJSON, with an extra attribute column
ddbs_geom_from_geojson(
  '{"type":"Point","coordinates":[-58.38,-34.60]}',
  city = "Buenos Aires",
  crs  = 4326
)
}

}
