async def _fetch(
flow_id: uuid.UUID,
yaml_only: bool = False
):
"""
Get Flow information using `flow_id`.
Following details are sent:
- Flow YAML
- Gateway host
- Gateway port
"""
try:
with flow_store._session():
host, port_expose, yaml_spec = flow_store._get(flow_id=flow_id)
if yaml_only:
return Response(content=yaml_spec,
media_type='application/yaml')
return {
'status_code': status.HTTP_200_OK,
'yaml': yaml_spec,
'host': host,
'port': port_expose
}
except KeyError:
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND,
detail=f'Flow ID {flow_id} not found! Please create a new Flow')
async def _delete(
flow_id: uuid.UUID
):
"""
Close Flow context
"""
with flow_store._session():
try:
flow_store._delete(flow_id=flow_id)
return {
'status_code': status.HTTP_200_OK
}
except KeyError:
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND,
detail=f'Flow ID {flow_id} not found! Please create a new Flow')
async def _create_from_pods(
pods: Union[List[PodModel]] = Body(...,
example=json.loads(PodModel().json()))
):
"""
Build a Flow using a list of `PodModel`
[
{
"name": "pod1",
"uses": "_pass"
},
{
"name": "pod2",
"uses": "_pass",
"host": "10.18.3.127",
"port_expose": 8000
}
]
"""
with flow_store._session():
try:
flow_id, host, port_expose = flow_store._create(config=pods)
except FlowCreationException:
raise HTTPException(status_code=404,
detail=f'Bad pods args')
except FlowStartException:
raise HTTPException(status_code=404,
detail=f'Flow couldn\'t get started')
return {
'status_code': status.HTTP_200_OK,
'flow_id': flow_id,
'host': host,
'port': port_expose,
'status': 'started'
}
async def _create_from_yaml(
yamlspec: UploadFile = File(...),
uses_files: List[UploadFile] = File(()),
pymodules_files: List[UploadFile] = File(())
):
"""
Build a flow using [Flow YAML](https://docs.jina.ai/chapters/yaml/yaml.html#flow-yaml-sytanx)
> Upload Flow yamlspec (`yamlspec`)
> Yamls that Pods use (`uses_files`) (Optional)
> Python modules (`pymodules_files`) that the Pods use (Optional)
**yamlspec**:
!Flow
with:
rest_api: true
compress_hwm: 1024
pods:
encode:
uses: helloworld.encoder.yml
parallel: 2
index:
uses: helloworld.indexer.yml
shards: 2
separated_workspace: true
**uses_files**: `helloworld.encoder.yml`
!MyEncoder
metas:
name: myenc
workspace: /tmp/blah
py_modules: components.py
requests:
on:
[IndexRequest, SearchRequest]:
- !Blob2PngURI {}
- !EncodeDriver {}
- !ExcludeQL
with:
fields:
- buffer
- chunks
**uses_files**: `helloworld.indexer.yml`
!CompoundIndexer
components:
- !NumpyIndexer
with:
index_filename: vec.gz
metas:
name: vecidx
workspace: /tmp/blah
- !BinaryPbIndexer
with:
index_filename: chunk.gz
metas:
name: chunkidx
workspace: /tmp/blah
metas:
name: chunk_indexer
workspace: /tmp/blah
**pymodules_files**: `components.py`
class MyEncoder(BaseImageEncoder):
def __init__(self):
...
"""
with flow_store._session():
try:
flow_id, host, port_expose = flow_store._create(config=yamlspec.file,
files=list(uses_files) + list(pymodules_files))
except FlowYamlParseException:
raise HTTPException(status_code=404,
detail=f'Invalid yaml file.')
except FlowStartException as e:
raise HTTPException(status_code=404,
detail=f'Flow couldn\'t get started: {repr(e)}')
return {
'status_code': status.HTTP_200_OK,
'flow_id': flow_id,
'host': host,
'port': port_expose,
'status': 'started'
}
def _shutdown():
with flow_store._session():
flow_store._delete_all()