Django ElasticSearch 引擎技术文档

1. 安装指南

环境要求

• Python 2.x 或 3.x
• Django 1.2 或更高版本
• Django Nonrel 分支
• Djangotoolbox
• pyes

安装步骤

1. 安装 Django Nonrel 分支

   pip install git+https://github.com/aparo/django-nonrel.git
   

2. 安装 Djangotoolbox

   pip install git+https://github.com/aparo/djangotoolbox.git
   

3. 安装 pyes

   pip install git+https://github.com/aparo/pyes.git
   

4. 安装 Django ElasticSearch 引擎

   pip install git+https://github.com/aparo/django-elasticsearch.git
   

2. 项目的使用说明

配置 Django 项目

在 Django 项目的 settings.py 文件中，添加以下配置：

DATABASES = {
    'default': {
        'ENGINE': 'django_elasticsearch',
        'NAME': 'your_database_name',
    }
}

创建模型

在 Django 项目中创建模型，并使用 ElasticSearch 引擎进行数据存储和查询。例如：

from django.db import models

class Person(models.Model):
    name = models.CharField(max_length=20)
    surname = models.CharField(max_length=20)
    age = models.IntegerField(null=True, blank=True)
                
    def __unicode__(self):
        return u"Person: %s %s" % (self.name, self.surname)

数据操作

• 创建数据

  p, created = Person.objects.get_or_create(name="John", defaults={'surname' : 'Doe'})
  print(created)  # 输出: True
  

• 更新数据

  p.age = 22
  p.save()
  

• 查询数据

  p = Person.objects.get(name__istartswith="JOH", age=22)
  print(p.pk)  # 输出: u'4bd212d9ccdec2510f000000'
  

3. 项目API使用文档

模型管理器

Django ElasticSearch 引擎提供了 Manager 和 Compiler，用于处理 ElasticSearch 的查询和数据操作。

查询API

• 基本查询

  Person.objects.get(name__istartswith="JOH", age=22)
  

• 模糊查询

  Person.objects.filter(name__icontains="ohn")
  

• 范围查询

  Person.objects.filter(age__gte=20, age__lte=30)
  

数据操作API

• 创建数据

  Person.objects.create(name="John", surname="Doe", age=22)
  

• 更新数据

  p = Person.objects.get(name="John")
  p.age = 25
  p.save()
  

• 删除数据

  p = Person.objects.get(name="John")
  p.delete()
  

4. 项目安装方式

通过 pip 安装

pip install git+https://github.com/aparo/django-elasticsearch.git

手动安装

1. 克隆项目仓库：

   git clone https://github.com/aparo/django-elasticsearch.git
   

2. 进入项目目录并安装：

   cd django-elasticsearch
   python setup.py install
   

通过以上步骤，您可以成功安装并使用 Django ElasticSearch 引擎，实现 Django 项目与 ElasticSearch 的集成。