doc.go

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Package arreflect provides utilities for converting between
// Apache Arrow arrays and Go structs using reflection.
//
// The primary entry points are the generic functions [At], [ToSlice],
// [FromSlice], [RecordToSlice], and [RecordFromSlice], which convert
// between Arrow arrays/records and Go slices of structs.
//
// Schema inference is available via [InferSchema] and [InferType].
//
// Arrow struct tags control field mapping:
//
//	type MyRow struct {
//	    Name  string  `arrow:"name"`
//	    Score float64 `arrow:"score"`
//	    Skip  string  `arrow:"-"`
//	    Enc   string  `arrow:"enc,dict"`
//	    T32   time.Time `arrow:"t32,time32"`
//	}
//
// Temporal type overrides for time.Time fields:
//
//	arrow:"field,date32"   — use Date32 instead of Timestamp
//	arrow:"field,date64"   — use Date64 instead of Timestamp
//	arrow:"field,time32"   — use Time32(ms) instead of Timestamp
//	arrow:"field,time64"   — use Time64(ns) instead of Timestamp
//
// Additional tag options:
//
//	arrow:"field,listview"              — use ListView instead of List for slice fields
//	arrow:"field,ree"                   — run-end encoding at top-level only (struct fields not supported)
//	arrow:"field,decimal(precision,scale)" — override decimal precision and scale (e.g., arrow:",decimal(18,2)")
package arreflect