ubconnect export

ubconnect export allows to export data from needs.json to an external service:

$ ubconnect export -c docs/conf.py  elasticsearch_config

Importing config from /home/.../docs/conf.py
Using provider "elasticsearch" for given service elasticsearch_config

Reading json data: Done
Connection to Elasticsearch url: ``http://127.0.0.1:9200``
Creating index needs
████████████████████████████████████████████████████████████████████████████████ 100% | Uploading need JIRA_PX-2:
Uploaded 8 elements.

Each need gets automatically a new option named uploaded_at , which has the current date and time as value.

Note

Please take into account that not all services are supporting all functions like ubconnect import or ubconnect export .

Take a look at the service badges on our main page, to figure out what is currently supported.

arguments

ubconnect export takes only one argument, the name of the service to call.

service

A given service must be defined inside needs_services of a conf.py file. By default ubconnect looks into the current working directory for a conf.py file. Use -c to specify another location.

The service key should start with the name of the tool, so that ubconnect is selecting the internal driver automatically. For instance: elasticsearch_my_server for Elasticsearch .

ubconnect export elasticsearch_my_server

options

-c / –conf

Can be used to specify the location of the conf.py file to use.

ubconnect export elasticsearch_my_server -c docs/conf.py

Default: conf.py (in the current working directory)

-j / –json

Location of a needs.json compatible file in which we shall export the service data to.

ubconnect export elasticsearch -j docs/needs.json

Default: needs.json

-v / –version

Version to take from the given needs.json file. All needs under this version will get exported.

ubconnect export elasticsearch -v 3.0.1

Default: current_version value set inside needs.json file

-x / –extra

Additional data, which shall be set on each exported need.

ubconnect export elasticsearch -x branch main

Default: None

-h / –hours

Allows you to manipulate the updated_at value of each need.

Useful to test uploads with the same data but with a different timestamp.

Allows positive and negative floating numbers (e.g. ‘2’ or ‘-3.5’), which will be added or subtracted from current time.

ubconnect export elasticsearch -h 2.5

Default: 0

-s / –skip

Skips every x element during export. So if 10 needs are defined inside needs.json'' and ``skip = 2 , then only 5 needs get exported.

Useful also only for tests, to scaling down the test data to export.

ubconnect export elasticsearch -s 5

Default: None