1.1.1.1.1. Service description
The following service returns connection parameters of the Data Ingest Service of workers which are available for ingesting regular (fully replicated) tables:
| method | resource name |
|---|---|
| GET | /ingest/regular |
Where the request object passed in a request's body has the following schema, in which a client would have to provide the name of a database:
{"database":<string>
}
The database should not be published at a time when the request was being called.
The service also supports an alternative method accepting a transaction identifier(transactions are always associated with the corresponding databases):
{"transaction_id":<number>
}
If the transaction identifier was provided then the transaction is required to be in the STARTED state at a time of a request.
In case of successful completion (see Error reporting in the REST API) the service returns the following object:
{..
"locations":[
{"worker":<string>,
"host":<string>,
"host_name":<string>,
"port":<number>,
"http_host":<string>,
"http_host_name":<string>,
"http_port":<number>
},
...
]
}
1.1.1.1.2. Notes on the connection parameters returned by the service for each worker
The table below explains the connection parameters returned by the service:
| attr | description |
|---|---|
host | The IP address of the worker's Ingest service that supports the proprietary binary protocol. |
host_name | The DNS name of the worker's Ingest service that supports the proprietary binary protocol. |
port | The port number of the worker's Ingest service that supports the proprietary binary protocol. This service requires the content of an input file to be sent directly to the service client. The Replication/Ingest system provides a ready-to-use application qserv-replica-file INGEST that is based on this protocol. |
http_host | The IP address of the worker's Ingest service that supports the HTTP protocol. |
http_host_name | The DNS name of the worker's Ingest service that supports the HTTP protocol. |
http_port | The DNS name of the worker's Ingest service that supports the HTTP protocol. The REST server that's placed in front of the service allows Ingesting a single file from a variety of external sources, such as the locally mounted (at the worker's host) filesystem, or a remote object store. |
Note that, In the current implementation of the Ingest system, values of the hostname attributes host_name and http_host_name are captured by the services themselves. The names may not be in the FQDN format. Therefore this information has to be used with caution and only in those contexts where the reported names could be reliably mapped to the external FQDN or IP addresses of the corresponding hosts/pods.