featurebase/batch
Travis Turner 12d608c80d
Move batch.Importer interface to pilosa.Importer (#2347)
* Move batch.Importer interface to pilosa.Importer

In addition to moving the interface, it updates all the methods to use
dax.TableID (for example) intead of a string pilosa index name.

* Change unused onPremImporter methods to no-op.

onPremImporter is a wrapper around API which implements the Importer
interface. This is currently only used by sql3 running locally in standard
(i.e not "serverless") mode. Because sql3 always sets
`useShardTransactionalEndpoint = true`, There are several methods which this
implemtation of the Importer interface does not use, and therefore they
intentionally no-op.
2022-12-09 14:24:47 -06:00
..
egpool Batch insert via SQL (multiple tuples) (#2243) 2022-10-29 14:24:33 -05:00
testdata Batch insert via SQL (multiple tuples) (#2243) 2022-10-29 14:24:33 -05:00
batch.go Move batch.Importer interface to pilosa.Importer (#2347) 2022-12-09 14:24:47 -06:00
batch_test.go Move batch.Importer interface to pilosa.Importer (#2347) 2022-12-09 14:24:47 -06:00
convert.go Batch insert via SQL (multiple tuples) (#2243) 2022-10-29 14:24:33 -05:00
docker-compose.yml Convert SchemaAPI interface to use dax.Table instead of pilosa.IndexInfo (#2336) 2022-12-08 11:35:17 -06:00
Dockerfile-test Batch insert via SQL (multiple tuples) (#2243) 2022-10-29 14:24:33 -05:00
Dockerfile-wait Batch insert via SQL (multiple tuples) (#2243) 2022-10-29 14:24:33 -05:00
error.go Batch insert via SQL (multiple tuples) (#2243) 2022-10-29 14:24:33 -05:00
Makefile Convert SchemaAPI interface to use dax.Table instead of pilosa.IndexInfo (#2336) 2022-12-08 11:35:17 -06:00
metrics.go Batch insert via SQL (multiple tuples) (#2243) 2022-10-29 14:24:33 -05:00
README.md Add DAX - full list of squashed commits below 2022-11-16 11:19:40 -06:00
wait.sh Batch insert via SQL (multiple tuples) (#2243) 2022-10-29 14:24:33 -05:00

batch

The batch package provides a standard tool set for batching records in a way that is most performant for ingesting those records into FeatureBase. The main implementation is Batch (which can be initated with the NewBatch() function). The NewBatch() function takes an Importer which contains all of the methods required to interact with FeatureBase; these include methods for doing string/id translation as well as for importing shards of data.

IDK uses the batch package internally. Another example where the batch package is used in the sql3 package. When an "INSERT INTO" statement is executed, the SQL engine uses a Batch to do key translation and build import batches prior to doing the final import.

Integration tests

To run the tests, you will need to install the following dependencies:

  1. Docker
  2. Docker Compose

In addition to these dependancies, you will need to be added to the molecula Gitlab account.

First start the test environment. This is a docker-compose environment that includes featurebase.

make startup

To build and run the integration tests, run:

make test-run-local

Then to shut down the test environment, run:

make shutdown

The previous command is equivalent to running the following:

make startup
sleep 30 # wait for services to come up
make test-run
make shutdown

To run an individual test, you can run the command directly using docker-compose. Note that you must run docker-compose build batch-test for docker to run the latest code. Modify the following as needed:

make startup
docker-compose build batch-test
docker-compose run batch-test /usr/local/go/bin/go test -count=1 -mod=vendor -run=TestCmdMainOne .