Bulk import from an S3 bucket
Load data from files in an existing Amazon Simple Storage Service (Amazon S3) with maximum performance.
It allows loading data from a bunch of
.ndjson.gz files on an AWS bucket directly to the Aidbox database with maximum performance.Be careful You should run only one replica of Aidbox to use
aidbox.bulk/load-from-bucket operation.- 1.The file must consist of Resources of the same type.
- 2.The file name should start with a name of the Resource type, then some postfix is possible, and extension
.ndjsonis required. Files can be placed in subdirectories of any level. Files with the wrong path structure will be ignored. - 3.Every resource in
.ndjsonfiles MUST contain id property.
Operation | id | resourceType |
|---|---|---|
aidbox.bulk/load-from-bucket | Required | Not required |
fhir/1/Patient.ndjson.gz
fhir/1/patient-01.ndjson.gz
Observation.ndjson.gz
import.ndjson
01-patient.ndjson.gz
fhir/Patient
Parameters
Result
Error
Object with the following structure:
bucket* defines your bucket connection string in formats3://<bucket-name>thread-numdefines how many threads will process the import. The default is 4.accountcredential:access-key-id* AWS key IDsecret-access-key* AWS secret keyregion* AWS Bucket region
disable-idx?the default isfalse. Allows to drop all indexes for resources, which data are going to be loaded. Indexes will be restored at the end of successful import. All information about dropped indexes is stored atDisabledIndexresources.drop-primary-key?the default isfalse. The same as the previous parameter, but drops primary key constraint for resources tables. This parameter disables all checks for duplicates for imported resources.upsert?the default isfalse. Ifupsert?isfalse, import for files withiduniqueness constraint violation will fail with an error, iftrue- records in the database will be overridden with records from import. Even whenupsert?istrue, it's still not allowed to have more than one record with the same id in one import file. Setting this option to true will cause a decrease in performance.schedulerpossible values:optimal,by-last-modified, the default isoptimal. Establishes the order in which the files are processed. Theoptimalvalue provides the best performance.by-last-modifiedshould be used withthread-num = 1to guarantee a stable order of file processing.prefixesarray of prefixes to specify which files should be processed. Example: with value["fhir/1/", "fhir/2/Patient"]only files from directory"fhir/1"andPatientfiles from directory"fhir/2"will be processed.connect-timeoutthe default is0. Specifies the number of milliseconds after which the file is considered as failed if connection to the resource could not be established. (e.g. in case of network issues). Zero is interpreted as an infinite timeout.read-timeoutthe default is0. Specifies the number of milliseconds after which the file is considered as failed if there is no data available to read (e.g. in case of network issues). Zero is interpreted as an infinite timeout.
Returns the string "Upload started"
Returns error message
Request
Response
POST /rpc
content-type: text/yaml
accept: text/yaml
method: aidbox.bulk/load-from-bucket
params:
bucket: s3://your-bucket-id
thread-num: 4
account:
access-key-id: your-key-id
secret-access-key: your-secret-access-key
region: us-east-1
Status: 200
result:
message: Upload from bucket <s3://your-bucket-id> started. 6 new files added.
progress:
total: 6
new-files-count: 6
For each file being imported via
load-from-bucket method, Aidbox creates LoaderFile resource. To find out how many resources were imported from a file, check the loaded field.Done
Error
{
"end": "2022-04-11T14:50:27.893Z",
"file": "/tmp/patient.ndjson.gz",
"size": 100,
"type": "Patient",
"bucket": "local",
"loaded": 20,
"status": "done"
}
{
"end": "2022-04-11T14:50:27.893Z",
"file": "/tmp/patient.ndjson.gz",
"size": 100,
"type": "Patient",
"bucket": "local",
"status": "error",
"error": {
"code": "23505",
"source": "postgres"
},
"message": "23505: ERROR: duplicate key value violates unique constraint \"patient_pkey\""
}
Sources of Error
There are the following sources of error for this request.
- AWS Error
- PostgreSQL Error
- Aidbox Error\
AWS Error
Code | Description |
|---|---|
InvalidAccount | The AWS access key ID or AWS secret access key that you provided is not valid. |
NoSuchKey | The specified S3 bucket or S3 object key does not exist. |
\
PostgreSQL Error
Aidbox Error
Any other errors than the above can be caught as Aidbox Error. An error message will be provided if available.\
On launch
aidbox.bulk/load-from-bucket checks if files from the bucket were planned to import and decides what to do:- If
ndjson.gzfile has it's relatedLoaderFileresource, the loader skips this file from import - If there is no related
LoaderFileresource, Aidbox puts this file to the queue creating aLoaderFileresource
In order to import a file one more time you should delete related
LoaderFile resource and relaunch aidbox.bulk/load-from-bucket.Files are processed completely. The loader doesn't support partial re-import.\
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "MinimalUserPolicyForBulkImport",
"Effect": "Allow",
"Action": [
"s3:ListBucket",
"s3:GetObject"
],
"Resource": [
"arn:aws:s3:::<your-bucket-name>",
"arn:aws:s3:::<your-bucket-name>/*"
]
}
]
}
\
Returns status and progress of import for specified bucket. Possible states are:
in-progress, completed, interrupted.State
interrupted means that aidbox was restarted during the loading process. If you run aidbox.bulk/load-from-bucket operation again on the same bucket, it will be continued.Request
Response
POST /rpc
content-type: text/yaml
accept: text/yaml
method: aidbox.bulk/load-from-bucket-status
params:
bucket: s3://your-bucket-id
Status: 200
result:
state: in-progress
progress:
total: 6
pending: 2
done: 4
Last modified 18d ago