Install the django-singlestore Connector

Run the following command to install the django-singlestore connector from PyPI:

pip install django-singlestore

To install the connector from source (GitHub repository) instead, run the following command:

pip install git+https://github.com/singlestore-labs/django-singlestore

Configure the DATABASES Setting

Add (or update) the DATABASES and other related settings in the Django application configuration as follows:

DATABASES = {
    "default": {
        "ENGINE": "django_singlestore",
        "HOST": "<endpoint>",
        "PORT": 3306,
        "USER": "<username>",
        "PASSWORD": "<password>",
        "NAME": "<database>",
    },
}

# SingleStore does not support datetime with timezones
USE_TZ = False

# AUTO_INCREMENT columns must have BIGINT data type
DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

where,

• endpoint: IP address or hostname of the SingleStore deployment.

• username: Username of the SingleStore database user.

• password: Password for the SingleStore database user.

• database: Name of the SingleStore database to connect with.

Remarks

CREATE TABLE user_group (
  id BIGINT AUTO_INCREMENT PRIMARY KEY,
  user_id BIGINT,
  group_id BIGINT,
  UNIQUE (user_id, group_id), -- not supported
  SHARD KEY (id));

# Intermediary model
class Paragraph(models.Model):
    text = models.TextField()
    page = models.ManyToManyField("Page", through="ParagraphPage")

class ParagraphPage(models.Model):
    paragraph = models.ForeignKey(Paragraph)
    page = models.ForeignKey("Page")

    class Meta:
        unique_together = (('paragraph', 'page'),)
        db_table = "queries_paragraph_page"

-- Custom DDL query
CREATE TABLE `queries_paragraph_page` (
  `paragraph_id` BIGINT NOT NULL,
  `page_id` BIGINT NOT NULL,
  SHARD KEY (`paragraph_id`),
  UNIQUE KEY (`paragraph_id`, `page_id`),
  KEY (`paragraph_id`),
  KEY (`page_id`)
);

Example

The following example shows how to run the Django Polls tutorial using SingleStore.

1. Create a new Django project named djangoExample and change to the djangoExample directory.

   Shell

   Copy

   django-admin startproject djangoExample
   cd djangoExample

   This command creates the following directory structure and files:

   Copy

   djangoExample/
   ├── manage.py
   └── djangoExample/
       ├── __init__.py
       ├── settings.py
       ├── urls.py
       ├── asgi.py
       └── wsgi.py

2. Create a new Django app named polls.

   Python

   Copy

   python manage.py startapp polls

   This command creates the following directory structure and files:

   Copy

   djangoExample/
   ├── polls/
       ├── __init__.py
       ├── admin.py
       ├── apps.py
       ├── migrations/
       │   └── __init__.py
       ├── models.py
       ├── tests.py
       └── views.py
   ├── djangoExample/*

3. Update the following in djangoExample/settings.py.

   • Database setting:

     Copy

     DATABASES = {
         "default": {
             "ENGINE": "django_singlestore",
             "HOST": "<endpoint>",
             "PORT": 3306,
             "USER": "<username>",
             "PASSWORD": "<password>",
             "NAME": "<databas>",
         },
     }

   • Disable timezone:

     Copy

     USE_TZ = False

   • Add the polls app to installed apps:

     Copy

     INSTALLED_APPS = [
         ...
         "polls",
     ]

4. Configure the following environment variables to change the default table type for compatibility:

   Shell

   Copy

   export DJANGO_SINGLESTORE_TABLE_STORAGE_TYPE_AUTH="ROWSTORE REFERENCE"
   export DJANGO_SINGLESTORE_TABLE_STORAGE_TYPE_ADMIN="ROWSTORE REFERENCE"
   export DJANGO_SINGLESTORE_TABLE_STORAGE_TYPE_CONTENTTYPES="ROWSTORE REFERENCE"
   export DJANGO_SINGLESTORE_TABLE_STORAGE_TYPE_SITES="ROWSTORE REFERENCE"

5. Create models. Add the following to polls/models.py:

   Python

   Copy

   # polls/models.py
   
   from django.db import models
   from django_singlestore.schema import ModelStorageManager
   
   class Question(models.Model):
       question_text = models.CharField(max_length=200, unique=True)
       pub_date = models.DateTimeField("date published")
   
       # Store as REFERENCE to allow UNIQUE constraint
       objects = ModelStorageManager(table_storage_type="REFERENCE")
   
       def __str__(self):
           return self.question_text
   
   
   class Choice(models.Model):
       question = models.ForeignKey(Question, on_delete=models.CASCADE)
       choice_text = models.CharField(max_length=200)
       votes = models.IntegerField(default=0)
   
       def __str__(self):
           return self.choice_text

6. Generate migration files and then apply the migrations.

   Shell

   Copy

   python manage.py makemigrations

   Migrations for 'polls':
     polls/migrations/0001_initial.py
       + Create model Question
       + Create model Choice

   Shell

   Copy

   python manage.py migrate

   Operations to perform:
     Apply all migrations: admin, auth, contenttypes, polls, sessions
   Running migrations:
     Applying contenttypes.0001_initial... OK
     Applying auth.0001_initial... OK
     Applying admin.0001_initial... OK
     Applying admin.0002_logentry_remove_auto_add... OK
     Applying admin.0003_logentry_add_action_flag_choices... OK
     Applying contenttypes.0002_remove_content_type_name... OK
     Applying auth.0002_alter_permission_name_max_length... OK
     Applying auth.0003_alter_user_email_max_length... OK
     Applying auth.0004_alter_user_username_opts... OK
     Applying auth.0005_alter_user_last_login_null... OK
     Applying auth.0006_require_contenttypes_0002... OK
     Applying auth.0007_alter_validators_add_error_messages... OK
     Applying auth.0008_alter_user_username_max_length... OK
     Applying auth.0009_alter_user_last_name_max_length... OK
     Applying auth.0010_alter_group_name_max_length... OK
     Applying auth.0011_update_proxy_permissions... OK
     Applying auth.0012_alter_user_first_name_max_length... OK
     Applying polls.0001_initial... OK
     Applying sessions.0001_initial... OK

7. Add the following code to polls/views.py:

   Python

   Copy

   from django.http import HttpResponse
   
   def index(request):
       return HttpResponse("Hello, world. You're at the polls index.")

8. Add the following code to polls/urls.py:

   Python

   Copy

   from django.urls import path
   from . import views
   
   urlpatterns = [
       path("", views.index, name="index"),
   ]

9. Update djangoExample/urls.py as follows:

   Python

   Copy

   from django.contrib import admin
   from django.urls import include, path
   
   urlpatterns = [
       path("polls/", include("polls.urls")),
       path("admin/", admin.site.urls),
   ]

10. Start the server.

    Shell

    Copy

    python manage.py runserver

11. Go to http://localhost:8000/polls/. Upon a successful server start, the following message is displayed in the browser:

    Hello, world. You're at the polls index.

Refer to Writing your first Django app, part 1 for related information.