// Copyright 2022 Molecula Corp. (DBA FeatureBase). // SPDX-License-Identifier: Apache-2.0 package ctl import ( "context" "encoding/csv" "fmt" "io" "math" "os" "strconv" "time" pilosa "github.com/molecula/featurebase/v3" "github.com/molecula/featurebase/v3/authn" "github.com/molecula/featurebase/v3/logger" "github.com/molecula/featurebase/v3/pql" "github.com/molecula/featurebase/v3/server" "github.com/pkg/errors" ) // TODO(rdp): add refresh token to this as well // ImportCommand represents a command for bulk importing data. type ImportCommand struct { // nolint: maligned // Destination host and port. Host string `json:"host"` // Name of the index & field to import into. Index string `json:"index"` Field string `json:"field"` // Options for the index to be created if it doesn't exist IndexOptions pilosa.IndexOptions // Options for the field to be created if it doesn't exist FieldOptions pilosa.FieldOptions // CreateSchema ensures the schema exists before import CreateSchema bool // Clear clears the import data as opposed to setting it. Clear bool // RowColMode indicates whether to read csv values as row id, col id or use default behavior. RowColMode bool // Filenames to import from. Paths []string `json:"paths"` // Size of buffer used to chunk import. BufferSize int `json:"bufferSize"` // Enables sorting of data file before import. Sort bool `json:"sort"` // Reusable client. client *pilosa.InternalClient // Standard input/output logDest logger.Logger TLS server.TLSConfig AuthToken string } // Logger returns the command's associated Logger to maintain CommandWithTLSSupport interface compatibility func (cmd *ImportCommand) Logger() logger.Logger { return cmd.logDest } // NewImportCommand returns a new instance of ImportCommand. func NewImportCommand(logdest logger.Logger) *ImportCommand { return &ImportCommand{ logDest: logdest, BufferSize: 10000000, } } // Run executes the main program execution. func (cmd *ImportCommand) Run(ctx context.Context) error { logger := cmd.Logger() // Validate arguments. // Index and field are validated early before the files are parsed. if cmd.Index == "" { return fmt.Errorf("%w: %v", UsageError, pilosa.ErrIndexRequired) } else if cmd.Field == "" { return fmt.Errorf("%w: %v", UsageError, pilosa.ErrFieldRequired) } else if len(cmd.Paths) == 0 { return fmt.Errorf("%w: path required", UsageError) } // Create a client to the server. client, err := commandClient(cmd) if err != nil { return errors.Wrap(err, "creating client") } cmd.client = client if cmd.AuthToken != "" { ctx = authn.WithAccessToken(ctx, "Bearer "+cmd.AuthToken) } if cmd.CreateSchema { if cmd.FieldOptions.Type == "" { // set the correct type for the field if cmd.FieldOptions.TimeQuantum != "" { cmd.FieldOptions.Type = pilosa.FieldTypeTime } else if !cmd.FieldOptions.Min.EqualTo(pql.NewDecimal(0, 0)) || !cmd.FieldOptions.Max.EqualTo(pql.NewDecimal(0, 0)) { cmd.FieldOptions.Type = pilosa.FieldTypeInt } else { cmd.FieldOptions.Type = pilosa.FieldTypeSet cmd.FieldOptions.CacheType = pilosa.CacheTypeRanked cmd.FieldOptions.CacheSize = pilosa.DefaultCacheSize } } err := cmd.ensureSchema(ctx) if err != nil { return errors.Wrap(err, "ensuring schema") } } // Determine the field type in order to correctly handle the input data. fieldType := pilosa.DefaultFieldType schema, err := cmd.client.Schema(ctx) if err != nil { return errors.Wrap(err, "getting schema") } var useColumnKeys, useRowKeys bool for _, index := range schema { if index.Name == cmd.Index { useColumnKeys = index.Options.Keys for _, field := range index.Fields { if field.Name == cmd.Field { useRowKeys = field.Options.Keys fieldType = field.Options.Type break } } break } } // Import each path and import by shard. for _, path := range cmd.Paths { logger.Printf("parsing: %s", path) if err := cmd.importPath(ctx, fieldType, useColumnKeys, useRowKeys, path); err != nil { return err } } return nil } func (cmd *ImportCommand) ensureSchema(ctx context.Context) error { err := cmd.client.EnsureIndex(ctx, cmd.Index, cmd.IndexOptions) if err != nil { return errors.Wrap(err, "creating index") } err = cmd.client.EnsureFieldWithOptions(ctx, cmd.Index, cmd.Field, cmd.FieldOptions) if err != nil { return errors.Wrap(err, "creating field") } return nil } // importPath parses a path into bits and imports it to the server. func (cmd *ImportCommand) importPath(ctx context.Context, fieldType string, useColumnKeys, useRowKeys bool, path string) error { // If fieldType is `int`, treat the import data as values to be range-encoded. if fieldType == pilosa.FieldTypeInt || fieldType == pilosa.FieldTypeDecimal { return cmd.bufferValues(ctx, useColumnKeys, fieldType == pilosa.FieldTypeDecimal, path) } return cmd.bufferBits(ctx, useColumnKeys, useRowKeys, path) } // bufferBits buffers slices of bits to be imported as a batch. func (cmd *ImportCommand) bufferBits(ctx context.Context, useColumnKeys, useRowKeys bool, path string) error { var r *csv.Reader if path != "-" { // Open file for reading. f, err := os.Open(path) if err != nil { return errors.Wrap(err, "opening file") } defer f.Close() // Read rows as bits. r = csv.NewReader(f) } else { r = csv.NewReader(os.Stdin) } r.FieldsPerRecord = -1 rnum := 0 req := &pilosa.ImportRequest{ Index: cmd.Index, Field: cmd.Field, Shard: ^uint64(0), } batchRecs := 0 // records in this batch lastTime := 0 // last record that had a timestamp for { rnum++ // Read CSV row. record, err := r.Read() if err == io.EOF { break } else if err != nil { return errors.Wrap(err, "reading") } // Ignore blank rows. if record[0] == "" { continue } else if len(record) < 2 { return fmt.Errorf("bad column count on row %d: col=%d", rnum, len(record)) } // Parse row id. if useRowKeys { req.RowKeys = append(req.RowKeys, record[0]) } else { var id uint64 if id, err = strconv.ParseUint(record[0], 10, 64); err != nil { return fmt.Errorf("invalid row id on row %d: %q", rnum, record[0]) } req.RowIDs = append(req.RowIDs, id) } // Parse column id. if useColumnKeys { req.ColumnKeys = append(req.ColumnKeys, record[1]) } else { var id uint64 if id, err = strconv.ParseUint(record[1], 10, 64); err != nil { return fmt.Errorf("invalid column id on row %d: %q", rnum, record[1]) } req.ColumnIDs = append(req.ColumnIDs, id) } batchRecs++ // Parse time, if exists. if len(record) > 2 && record[2] != "" { t, err := time.Parse(pilosa.TimeFormat, record[2]) if err != nil { return fmt.Errorf("invalid timestamp on row %d: %q", rnum, record[2]) } if lastTime < batchRecs { req.Timestamps = append(req.Timestamps, make([]int64, batchRecs-lastTime)...) } req.Timestamps = append(req.Timestamps, t.UnixNano()) lastTime = batchRecs } // If we've reached the buffer size then import bits. if batchRecs == cmd.BufferSize { // pad timestamps out with 0s if lastTime > 0 && lastTime < batchRecs { req.Timestamps = append(req.Timestamps, make([]int64, batchRecs-lastTime)...) } if err := cmd.importBits(ctx, req); err != nil { return err } req.ColumnIDs = req.ColumnIDs[:0] req.RowIDs = req.RowIDs[:0] req.ColumnKeys = req.ColumnKeys[:0] req.RowKeys = req.RowKeys[:0] req.Timestamps = req.Timestamps[:0] lastTime = 0 batchRecs = 0 } } // If there are still bits in the buffer then flush them. if batchRecs == 0 { return nil } if lastTime > 0 && lastTime < batchRecs { req.Timestamps = append(req.Timestamps, make([]int64, batchRecs-lastTime)...) } return cmd.importBits(ctx, req) } // importBits sends batches of bits to the server. func (cmd *ImportCommand) importBits(ctx context.Context, req *pilosa.ImportRequest) error { req.Shard = ^uint64(0) return cmd.client.Import(ctx, nil, req, &pilosa.ImportOptions{Clear: cmd.Clear}) } // bufferValues buffers slices of record identifiers and values to be imported as a batch. func (cmd *ImportCommand) bufferValues(ctx context.Context, useColumnKeys, parseAsFloat bool, path string) error { req := &pilosa.ImportValueRequest{ Index: cmd.Index, Field: cmd.Field, Shard: math.MaxUint64, } var r *csv.Reader if path != "-" { // Open file for reading. f, err := os.Open(path) if err != nil { return errors.Wrap(err, "opening file") } defer f.Close() // Read rows as bits. r = csv.NewReader(f) } else { r = csv.NewReader(os.Stdin) } r.FieldsPerRecord = -1 rnum := 0 for { rnum++ // Read CSV row. record, err := r.Read() if err == io.EOF { break } else if err != nil { return errors.Wrap(err, "reading") } // Ignore blank rows. if record[0] == "" { continue } else if len(record) < 2 { return fmt.Errorf("bad column count on row %d: col=%d", rnum, len(record)) } var rowIdx, colIdx uint32 if cmd.RowColMode { colIdx = 1 } else { rowIdx = 1 } // Parse column id. if useColumnKeys { req.ColumnKeys = append(req.ColumnKeys, record[colIdx]) } else if columnID, err := strconv.ParseUint(record[colIdx], 10, 64); err == nil { req.ColumnIDs = append(req.ColumnIDs, columnID) } else { return fmt.Errorf("invalid column id on row %d: %q", rnum, record[colIdx]) } // Parse value. if parseAsFloat { value, err := strconv.ParseFloat(record[rowIdx], 64) if err != nil { return errors.Wrapf(err, "parsing value '%s' as float", record[rowIdx]) } req.FloatValues = append(req.FloatValues, value) } else { value, err := strconv.ParseInt(record[rowIdx], 10, 64) if err != nil { return errors.Wrapf(err, "invalid value on row %d: %q", rnum, record[rowIdx]) } req.Values = append(req.Values, value) } // If we've reached the buffer size then import the batch. if len(req.ColumnKeys) == cmd.BufferSize || len(req.ColumnIDs) == cmd.BufferSize { if err := cmd.client.ImportValue(ctx, nil, req, &pilosa.ImportOptions{Clear: cmd.Clear}); err != nil { return errors.Wrap(err, "importing values") } req.ColumnIDs = req.ColumnIDs[:0] req.ColumnKeys = req.ColumnKeys[:0] req.Values = req.Values[:0] req.FloatValues = req.FloatValues[:0] } } // If there are still values in the buffer then flush them. return errors.Wrap(cmd.client.ImportValue(ctx, nil, req, &pilosa.ImportOptions{Clear: cmd.Clear}), "importing values") } func (cmd *ImportCommand) TLSHost() string { return cmd.Host } func (cmd *ImportCommand) TLSConfiguration() server.TLSConfig { return cmd.TLS }