Skip to content

Database Serve API

create_database()

Create a database.

Returns:

Name Type Description
dict

The status of the operation.
Source code in lynse/api/http_api/http_api/database_ops.py 
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
@database_ops.route('/create_database', methods=['POST'])
def create_database():
    """Create a database.

    Returns:
        dict: The status of the operation.
    """
    from ....api.native_api.database_manager import DatabaseManager
    from ....api.native_api.high_level import LocalClient

    data = request.json
    try:
        data_manager = DatabaseManager(config.LYNSE_DEFAULT_ROOT_PATH)
        data_manager.register(data['database_name'])

        if data['drop_if_exists']:
            LocalClient(root_path=root_path / data['database_name']).drop_database()

        LocalClient(root_path=root_path / data['database_name'])
        return Response(json.dumps({'status': 'success', 'params': {'database_name': data['database_name']}},
                                   sort_keys=False), mimetype='application/json')
    except Exception as e:
        return jsonify({'error': str(e)}), 500

database_exists()

Check if the database exists.

Returns:

Name Type Description
dict

The status of the operation.
Source code in lynse/api/http_api/http_api/database_ops.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
@database_ops.route('/database_exists', methods=['POST'])
def database_exists():
    """Check if the database exists.

    Returns:
        dict: The status of the operation.
    """
    data = request.json
    try:
        exists = (root_path / data['database_name']).exists()
        return Response(json.dumps({
            'status': 'success', 'params': {
                'exists': True if exists else False
            }
        },
            sort_keys=False), mimetype='application/json')
    except Exception as e:
        return jsonify({'error': str(e)}), 500

delete_database()

Delete a database.

Returns:

Name Type Description
dict

The status of the operation.
Source code in lynse/api/http_api/http_api/database_ops.py 
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
@database_ops.route('/delete_database', methods=['POST'])
def delete_database():
    """Delete a database.

    Returns:
        dict: The status of the operation.
    """
    from ....api.native_api.database_manager import DatabaseManager

    data = request.json
    try:
        data_manager = DatabaseManager(config.LYNSE_DEFAULT_ROOT_PATH)
        data_manager.delete(data['database_name'])
        return Response(json.dumps({'status': 'success', 'params': {'database_name': data['database_name']}},
                                   sort_keys=False), mimetype='application/json')
    except Exception as e:
        return jsonify({'error': str(e)}), 500

get_environment()

Get the environment variables.

Returns:

Name Type Description
dict

The status of the operation.
Source code in lynse/api/http_api/http_api/database_ops.py 
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
@database_ops.route('/get_environment', methods=['GET'])
def get_environment():
    """Get the environment variables.

    Returns:
        dict: The status of the operation.
    """
    env_list = ['LYNSE_LOG_LEVEL', 'LYNSE_LOG_PATH', 'LYNSE_TRUNCATE_LOG', 'LYNSE_LOG_WITH_TIME',
                'LYNSE_KMEANS_EPOCHS', 'LYNSE_SEARCH_CACHE_SIZE']

    params = {key: eval("global_config.key") for key in env_list}
    try:
        return Response(json.dumps({'status': 'success', 'params': params}, sort_keys=False),
                        mimetype='application/json')
    except Exception as e:
        return jsonify({'error': str(e)}), 500

list_databases()

List all databases.

Returns:

Name Type Description
dict

The status of the operation.
Source code in lynse/api/http_api/http_api/database_ops.py 
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
@database_ops.route('/list_databases', methods=['GET'])
def list_databases():
    """List all databases.

    Returns:
        dict: The status of the operation.
    """
    from ....api.native_api.database_manager import DatabaseManager

    try:
        data_manager = DatabaseManager(config.LYNSE_DEFAULT_ROOT_PATH)
        databases = data_manager.list_database()
        return Response(json.dumps({'status': 'success', 'params': {'databases': databases}}, sort_keys=False),
                        mimetype='application/json')
    except Exception as e:
        return jsonify({'error': str(e)}), 500

set_environment()

Set the environment variables.

Returns:

Name Type Description
dict

The status of the operation.
Source code in lynse/api/http_api/http_api/database_ops.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
@database_ops.route('/set_environment', methods=['POST'])
def set_environment():
    """Set the environment variables.

    Returns:
        dict: The status of the operation.
    """
    data = request.json
    if not data:
        return jsonify({'error': 'No data provided'}), 400

    try:
        for key, value in data.items():
            os.environ[key] = value
        return Response(json.dumps({'status': 'success', 'params': data}, sort_keys=False), mimetype='application/json')
    except Exception as e:
        return jsonify({'error': str(e)}), 500