geoparquet

Documentation

Index

• Constants
• Variables
• func FromParquet(input parquet.ReaderAtSeeker, output io.Writer, convertOptions *ConvertOptions) error
• func GetMetadataValue(keyValueMetadata metadata.KeyValueMetadata) (string, error)
• type ConvertOptions
• type FeatureWriter
  • func NewFeatureWriter(config *WriterConfig) (*FeatureWriter, error)
  • func (w *FeatureWriter) Close() error
  • func (w *FeatureWriter) Write(feature *geo.Feature) error
• type GeometryColumn
  • func (col *GeometryColumn) GetGeometryTypes() []string
• type Metadata
  • func DefaultMetadata() *Metadata
  • func GetMetadata(keyValueMetadata metadata.KeyValueMetadata) (*Metadata, error)
  • func (m *Metadata) Clone() *Metadata
• type Proj
  • func (p *Proj) String() string
• type ProjId
• type ReaderConfig
• type RecordReader
  • func NewRecordReader(config *ReaderConfig) (*RecordReader, error)
  • func (r *RecordReader) Close() error
  • func (r *RecordReader) Metadata() *Metadata
  • func (r *RecordReader) Read() (arrow.Record, error)
  • func (r *RecordReader) Schema() *schema.Schema
• type RecordWriter
  • func NewRecordWriter(config *WriterConfig) (*RecordWriter, error)
  • func (w *RecordWriter) AppendKeyValueMetadata(key string, value string) error
  • func (w *RecordWriter) Close() error
  • func (w *RecordWriter) Write(record arrow.Record) error
• type WriterConfig

Constants

const (
	Version                     = "1.0.0"
	MetadataKey                 = "geo"
	EdgesPlanar                 = "planar"
	EdgesSpherical              = "spherical"
	OrientationCounterClockwise = "counterclockwise"
	DefaultGeometryColumn       = "geometry"
	DefaultGeometryEncoding     = geo.EncodingWKB
)

Variables

var ErrDuplicateMetadata = fmt.Errorf("found more than one %s metadata key", MetadataKey)

var ErrNoMetadata = fmt.Errorf("missing %s metadata key", MetadataKey)

var GeometryTypes = []string{
	"Point",
	"LineString",
	"Polygon",
	"MultiPoint",
	"MultiLineString",
	"MultiPolygon",
	"GeometryCollection",
	"Point Z",
	"LineString Z",
	"Polygon Z",
	"MultiPoint Z",
	"MultiLineString Z",
	"MultiPolygon Z",
	"GeometryCollection Z",
}

Functions

func FromParquet

func FromParquet(input parquet.ReaderAtSeeker, output io.Writer, convertOptions *ConvertOptions) error

func GetMetadataValue

func GetMetadataValue(keyValueMetadata metadata.KeyValueMetadata) (string, error)

Types

type ConvertOptions

type ConvertOptions struct {
	InputPrimaryColumn string
	Compression        string
	RowGroupLength     int
}

type FeatureWriter

type FeatureWriter struct {
	// contains filtered or unexported fields
}

func NewFeatureWriter

func NewFeatureWriter(config *WriterConfig) (*FeatureWriter, error)

func (*FeatureWriter) Close

func (w *FeatureWriter) Close() error

func (*FeatureWriter) Write

func (w *FeatureWriter) Write(feature *geo.Feature) error

type GeometryColumn

type GeometryColumn struct {
	Encoding      string    `json:"encoding"`
	GeometryType  any       `json:"geometry_type,omitempty"`
	GeometryTypes any       `json:"geometry_types"`
	CRS           *Proj     `json:"crs,omitempty"`
	Edges         string    `json:"edges,omitempty"`
	Orientation   string    `json:"orientation,omitempty"`
	Bounds        []float64 `json:"bbox,omitempty"`
	Epoch         float64   `json:"epoch,omitempty"`
}

func (*GeometryColumn) GetGeometryTypes

func (col *GeometryColumn) GetGeometryTypes() []string

type Metadata

type Metadata struct {
	Version       string                     `json:"version"`
	PrimaryColumn string                     `json:"primary_column"`
	Columns       map[string]*GeometryColumn `json:"columns"`
}

func DefaultMetadata

func DefaultMetadata() *Metadata

func GetMetadata

func GetMetadata(keyValueMetadata metadata.KeyValueMetadata) (*Metadata, error)

func (*Metadata) Clone

func (m *Metadata) Clone() *Metadata

type Proj

type Proj struct {
	Name string  `json:"name"`
	Id   *ProjId `json:"id"`
}

func (*Proj) String

func (p *Proj) String() string

type ProjId

type ProjId struct {
	Authority string `json:"authority"`
	Code      any    `json:"code"`
}

type ReaderConfig

type ReaderConfig struct {
	BatchSize int
	Reader    parquet.ReaderAtSeeker
	File      *file.Reader
	Context   context.Context
}

type RecordReader

type RecordReader struct {
	// contains filtered or unexported fields
}

func NewRecordReader

func NewRecordReader(config *ReaderConfig) (*RecordReader, error)

func (*RecordReader) Close

func (r *RecordReader) Close() error

func (*RecordReader) Metadata

func (r *RecordReader) Metadata() *Metadata

func (*RecordReader) Read

func (r *RecordReader) Read() (arrow.Record, error)

func (*RecordReader) Schema

func (r *RecordReader) Schema() *schema.Schema

type RecordWriter

type RecordWriter struct {
	// contains filtered or unexported fields
}

func NewRecordWriter

func NewRecordWriter(config *WriterConfig) (*RecordWriter, error)

func (*RecordWriter) AppendKeyValueMetadata

func (w *RecordWriter) AppendKeyValueMetadata(key string, value string) error

func (*RecordWriter) Close

func (w *RecordWriter) Close() error

func (*RecordWriter) Write

func (w *RecordWriter) Write(record arrow.Record) error

type WriterConfig

type WriterConfig struct {
	Writer             io.Writer
	Metadata           *Metadata
	ParquetWriterProps *parquet.WriterProperties
	ArrowWriterProps   *pqarrow.ArrowWriterProperties
	ArrowSchema        *arrow.Schema
}