Dowell DataCube API

Available APIs

• Health Check
  Checks the health status of the API.
  /health_check/
  GET Request Body

  {}

  Example Responses
  GET:

  {
      "success": true,
      "message": "API is healthy"
  }

• Create Database
  Creates a new database with specified collections and fields.
  /api/create_database/
  POST Request Body

  {
      "db_name": "new_database",
      "collections":  [
          {
              "name": "users",
              "fields": [
                  {"name": "username", "type": "string"},
                  {"name": "age", "type": "number"}
              ]
          }
      ]
  }

  Example Responses
  POST:

  {
      "success": true,
      "message": "Database created successfully"
  }

• Add Collections
  Adds new collections to an existing database, specifying document fields for each collection.
  /api/add_collection/
  POST Request Body

  {
      "database_id": "507f1f77bcf86cd799439011",
      "collections": [
          {
              "name": "orders",
              "fields": [
                  {"name": "order_id", "type": "string"},
                  {"name": "total", "type": "number"}
              ]
          }
      ]
  }

  Example Responses
  POST:

  {
      "success": true,
      "message": "Collections added successfully"
  }

• List Collections
  Lists all collections in a specified database.
  /api/list_collections/
  Request Parameters

  {'database_id': '507f1f77bcf86cd799439011'}

  Example Responses
  GET:

  {
      "success": true,
      "message": "Collections retrieved successfully",
      "data": [
          "users",
          "products"
      ]
  }

• Create Documents
  Creates documents in a specified collection.
  /api/crud/
  POST Request Body

  {
      "database_id": "507f1f77bcf86cd799439011",
      "collection_name": "users",
      "data": [
          {
              "username": "john_doe",
              "age": 30
          }
      ]
  }

  Example Responses
  POST:

  {
      "success": true,
      "message": "Documents inserted successfully!"
  }

• Read Documents
  Reads documents from a specified collection with optional filters.
  /api/crud/
  Request Parameters

  {'database_id': '507f1f77bcf86cd799439011', 'collection_name': 'users', 'filters': '{"age":{"$gt":25}}', 'limit': 50, 'offset': 0}

  Example Responses
  GET:

  {
      "success": true,
      "message": "Data found!",
      "data": [...]
  }

• Update Documents
  Updates documents in a specified collection.
  /api/crud/
  PUT Request Body

  {
      "database_id": "507f1f77bcf86cd799439011",
      "collection_name": "users",
      "filters": {"username": "john_doe"},
      "update_data": {"age": 31}
  }

  Example Responses
  PUT:

  {
      "success": true,
      "message": "Document updated successfully"
  }

• Delete Documents
  Deletes documents from a specified collection.
  /api/crud/
  DELETE Request Body

  {
      "database_id": "507f1f77bcf86cd799439011",
      "collection_name": "users",
      "filters": {"username": "john_doe"},
      "soft_delete": true
  }

  Example Responses
  DELETE:

  {
      "success": true,
      "message": "Document deleted successfully"
  }

• List Databases
  Lists all databases in the MongoDB cluster with pagination and optional filtering.
  /api/list_databases/
  Request Parameters

  {'page': 1, 'page_size': 10, 'filter': 'example'}

  Example Responses
  GET:

  {
      "success": true,
      "message": "Databases retrieved successfully",
      "data": [
          {
        "name": "example_db",
        "num_collections": 3
      },
      {
        "name": "user_data_db",
        "num_collections": 1
      },
    ]
  }

• Drop Database
  Deletes a database and all its collections and metadata with confirmation.
  /api/drop_database/
  DELETE Request Body

  {
      "database_id": "507f1f77bcf86cd799439011",
      "confirmation": "example_db"
  }

  Example Responses
  DELETE:

  {
      "success": true,
      "message": "Database dropped successfully"
  }

• Drop Collections
  Deletes specified collections from a database.
  /api/drop_collections/
  DELETE Request Body

  {
      "database_id": "507f1f77bcf86cd799439011",
      "collection_names": ["users", "orders"]
  }

  Example Responses
  DELETE:

  {
      "success": true,
      "message": "Collections dropped successfully"
  }

• Get Database Metadata
  Fetches metadata for a specific database, including collections, fields, and additional metadata.
  /api/get_metadata/
  Request Parameters

  {'database_id': '507f1f77bcf86cd799439011'}

  Example Responses
  GET:

  {
      "success": true,
      "message": "Metadata retrieved successfully",
      "data": {
          "database_name": "example_db",
          "number_of_collections": 3,
          "number_of_fields": 12,
          "collections_metadata": [...]
      }
  }