% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ddbs_queries.R
\name{ddbs_get_npoints}
\alias{ddbs_get_npoints}
\alias{ddbs_get_ngeometries}
\alias{ddbs_get_ninterior_rings}
\title{Count geometry components}
\usage{
ddbs_get_npoints(
  x,
  new_column = "npoints",
  conn = NULL,
  name = NULL,
  mode = NULL,
  overwrite = FALSE,
  quiet = FALSE
)

ddbs_get_ngeometries(
  x,
  new_column = "ngeometries",
  conn = NULL,
  name = NULL,
  mode = NULL,
  overwrite = FALSE,
  quiet = FALSE
)

ddbs_get_ninterior_rings(
  x,
  new_column = "ninterior_rings",
  conn = NULL,
  name = NULL,
  mode = NULL,
  overwrite = FALSE,
  quiet = FALSE
)
}
\arguments{
\item{x}{Input spatial data. Can be:
\itemize{
\item A \code{duckspatial_df} object (lazy spatial data frame via dbplyr)
\item An \code{sf} object
\item A \code{tbl_lazy} from dbplyr
\item A character string naming a table/view in \code{conn}
}
Data is returned from this object.}

\item{new_column}{Name of the new column to create on the input data. Ignored
with \code{mode = "sf"}.}

\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{
Functions to count the number of points, sub-geometries or interior rings in
a geometry
}
\details{
These functions query structural properties of geometries:
\itemize{
\item \code{ddbs_get_npoints()} returns the number of points (vertices) in a geometry.
For LINESTRING geometries this is the vertex count; for POLYGON types it
includes all vertices of the exterior ring and any interior rings.
\item \code{ddbs_get_ngeometries()} returns the number of sub-geometries in a
GEOMETRYCOLLECTION or MULTI* geometry (e.g. MULTIPOLYGON, MULTILINESTRING).
Returns 1 for simple (non-collection) geometry types.
\item \code{ddbs_get_ninterior_rings()} returns the number of interior rings (holes)
in a POLYGON geometry. Returns 0 for polygons without holes and \code{NULL} for
non-polygon geometry types.
}
}
\examples{
\dontrun{
## load packages
library(dplyr)
library(duckspatial)

## read data
countries_ddbs <- ddbs_open_dataset(
  system.file("spatial/countries.geojson",
  package = "duckspatial")
)

## count points, sub-geometries and interior rings
ddbs_get_npoints(countries_ddbs)
ddbs_get_ngeometries(countries_ddbs)
ddbs_get_ninterior_rings(countries_ddbs)
}

}
