Text Search?

[tonybaloney]

I couldn't find anything in the docs to do text search (https://docs.mongodb.com/manual/reference/operator/query/text/)

I have a document :

class Location(Document):

    name: str
    private: bool = False

    class Meta:
        table = "locations"

I want to do a search like "where name contains 'New York'"

Is this possible at the moment?

[roman-right]

For this you need a text index.

Here is the MongoDB doc: https://docs.mongodb.com/manual/core/index-text/
Beanie doc: https://roman-right.github.io/beanie/tutorial/indexes-%26-collection-names/#indexes

The simplest way to add it is:

class Location(Document):
    name: Indexed(str, index_type=TEXT)
    private: bool = False

    class Collection:
        name = "locations"

Then you can use operator Text or native MongoDB query.

Full working example:

import asyncio

from motor.motor_asyncio import AsyncIOMotorClient
from pymongo import TEXT

from beanie import Document, Indexed, init_beanie
from beanie.operators import Text

MONGO_URI = "YOUR URI"


class Location(Document):
    name: Indexed(str, index_type=TEXT)
    private: bool = False

    class Collection:
        name = "locations"


async def main():
    db = AsyncIOMotorClient(MONGO_URI).test_db
    await init_beanie(database=db, document_models=[Location])

    # await Location(name="some test New York bla bla").insert()
    # await Location(name="some test bla bla").insert()

    l = await Location.find(Text("New York")).to_list()
    print(l)


asyncio.run(main())

Thank you for the issue. I'll add this point to the doc.

[github-actions]

This issue is stale because it has been open 30 days with no activity.

[github-actions]

This issue was closed because it has been stalled for 14 days with no activity.