initial commit

Author: moluwole

django_index_project/__init__.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for django_index_project project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.1/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "django_index_project.settings")
+
+application = get_asgi_application()

django_index_project/asgi.py

@@ -0,0 +1,135 @@
+"""
+Django settings for django_index_project project.
+
+Generated by 'django-admin startproject' using Django 5.1.3.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.1/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/5.1/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/5.1/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "django-insecure-+031!wnlhf@ij86qi%7mu^f+r4hhezl=tz&05mvbopvh^)g_@u"
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = ["*"]
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "product",
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+]
+
+ROOT_URLCONF = "django_index_project.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = "django_index_project.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/5.1/ref/settings/#databases
+
+# DATABASES = {
+#     'default': {
+#         'ENGINE': 'django.db.backends.sqlite3',
+#         'NAME': BASE_DIR / 'db.sqlite3',
+#     }
+# }
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.postgresql",
+        "HOST": "127.0.0.1",
+        "PORT": 5432,
+        "USER": "monitaur",
+        "PASSWORD": "dummy",
+        "NAME": "monitaur",
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/5.1/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/5.1/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = "UTC"
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/5.1/howto/static-files/
+
+STATIC_URL = "static/"
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/5.1/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

django_index_project/settings.py

@@ -0,0 +1,23 @@
+"""
+URL configuration for django_index_project project.
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/5.1/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+
+from django.contrib import admin
+from django.urls import path
+
+urlpatterns = [
+    path("admin/", admin.site.urls),
+]

django_index_project/urls.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for django_index_project project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.1/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "django_index_project.settings")
+
+application = get_wsgi_application()

django_index_project/wsgi.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "django_index_project.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()

manage.py

@@ -0,0 +1,12 @@
+from django.contrib import admin
+
+# Register your models here.
+from .models import (
+    ProductWithCompositeIndex,
+    ProductWithSingleIndex,
+    ProductWithoutIndex,
+)
+
+admin.site.register(ProductWithCompositeIndex)
+admin.site.register(ProductWithoutIndex)
+admin.site.register(ProductWithSingleIndex)

product/__init__.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class ProductConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "product"

product/admin.py

@@ -0,0 +1,45 @@
+import factory
+import random
+
+from product.models import (
+    ProductWithCompositeIndex,
+    ProductWithSingleIndex,
+    ProductWithoutIndex,
+)
+
+
+class ProductFactoryMeta(factory.Factory):
+    name = factory.Faker("name")
+    category = lambda x: x.category
+    price = factory.LazyAttribute(lambda _: random.randint(1, 1000))
+
+    class Meta:
+        abstract = True
+
+    class Params:
+        category = "category1"
+
+
+class ProductWithoutIndexFactory(
+    factory.django.DjangoModelFactory, ProductFactoryMeta
+):
+
+    class Meta:
+        model = ProductWithoutIndex
+
+
+class ProductWithSingleIndexFactory(
+    factory.django.DjangoModelFactory, ProductFactoryMeta
+):
+
+    class Meta:
+        model = ProductWithSingleIndex
+
+
+class ProductWithCompositeIndexFactory(
+    factory.django.DjangoModelFactory, ProductFactoryMeta
+):
+
+    class Meta:
+        model = ProductWithCompositeIndex
+

product/apps.py

@@ -0,0 +1,66 @@
+from django.core.management.base import BaseCommand, CommandParser
+
+from pprint import pprint
+import json
+
+from product.models import (
+    ProductWithCompositeIndex,
+    ProductWithSingleIndex,
+    ProductWithoutIndex,
+)
+
+from django.db.models import Q
+
+
+class Command(BaseCommand):
+    help = "Test select queries with and without indexes"
+
+    def add_arguments(self, parser: CommandParser):
+        parser.add_argument(
+            "--table_type",
+            type=int,
+            default=1,
+            help="1: ProductWithoutIndex, 2: ProductWithSingleIndex, 3: ProductWithCompositeIndex",
+        )
+        parser.add_argument(
+            "--category",
+            type=str,
+            choices=["electronics", "clothing", "home appliances"],
+            help="category",
+        )
+
+        parser.add_argument(
+            "--price",
+            type=int,
+            help="price",
+        )
+
+    def handle(self, *args, **kwargs):
+        print("Running tests...")
+
+        table_type = kwargs.get("table_type")
+        if table_type < 1 or table_type > 3:
+            print("Table type must be between 1 and 3")
+            return
+        
+        if table_type == 1:
+            table_model = ProductWithoutIndex
+        elif table_type == 2:
+            table_model = ProductWithSingleIndex
+        else:
+            table_model = ProductWithCompositeIndex
+
+        category = kwargs.get("category", None)
+        price = kwargs.get("price", None)
+
+        if category and price:
+            queryset = table_model.objects.filter(Q(category=category) & Q(price__lte=price))
+        elif category:
+            queryset = table_model.objects.filter(category=category)
+        elif price:
+            queryset = table_model.objects.filter(price__lte=price)
+        else:
+            queryset = table_model.objects.all()
+
+        explain_output = queryset.explain(analyze=True, verbose=True, format="json")
+        pprint(json.loads(explain_output))

product/management/__init__.py

@@ -0,0 +1,35 @@
+
+from django.core.management.base import BaseCommand
+from django.core.management import call_command
+
+from .factory_data import (
+    ProductWithCompositeIndexFactory,
+    ProductWithSingleIndexFactory,
+    ProductWithoutIndexFactory,
+)
+
+
+class Command(BaseCommand):
+    help = "Seed the database with dummy data with 3 different categories (electronics, clothing, home appliances)"
+
+    def handle(self, *args, **kwargs):
+        print("Seeding data...")
+        call_command("flush", "--noinput")
+
+        for category in ["electronics", "clothing", "home appliances"]:
+            print(f"Seeding data for category: {category}")
+            print("*" * 50)
+            print("\nCreating 500,000 records for ProductWithoutIndex")
+            ProductWithoutIndexFactory.create_batch(500000, category=category)
+            print("#" * 50)
+            print("\nCreating 500,000 records for ProductWithSingleIndex")
+
+            ProductWithSingleIndexFactory.create_batch(500000, category=category)
+            print("#" * 50)
+            print("\nCreating 500,000 records for ProductWithCompositeIndex")
+            ProductWithCompositeIndexFactory.create_batch(500000, category=category)
+        
+            print("#" * 50)
+            print("Done")
+
+        print("Data seeded successfully")