LeanStorage Python Guide

The LeanStorage Python SDK can be used to persist and query data in LeanCloud. The code below shows how you can create an object and store it into the cloud:

# Declare a class
Todo = leancloud.Object.extend('Todo')

# Create an object
todo = Todo()

# Set values of fields
todo.set('title',   'R&D Weekly Meeting')
todo.set('content', 'All team members, Tue 2pm')

# Save the object to the cloud
todo.save()

Getting Started

Installing SDK

The easiest way to integrate our SDK in your project is to use pip. Run the following command to install it:

pip install leancloud

You may also install the SDK with easy_install:

easy_install leancloud

Depending on your environment, you may need to add sudo at the beginning of the command.

Initializing Your Project

Add the following code into your project:

import leancloud

leancloud.init('{{appid}}', '{{appkey}}')
# Or use Master Key
# leancloud.init('{{appid}}', master_key='{{masterkey}}')
leancloud.use_region('US')

Debugging

You can easily trace the problems in your project by turning debug logs on during the development phase. Once enabled, details of every request made by the SDK along with errors will be output to IDE, browser console, or your app's Dashboard > LeanEngine > App logs.

# Place the code at the beginning of the start-up script
# If used in LeanEngine, the start-up script is wsgi.py
import logging

logging.basicConfig(level=logging.DEBUG)

Objects

leancloud.Object

Storing data on LeanCloud is built around leancloud.Object. Each leancloud.Object contains key-value pairs of JSON-compatible data. This data is schema free, which means that you don't need to specify ahead of time what keys exist on each leancloud.Object. Simply set whatever key-value pairs you want, and our backend will store it.

For example, the leancloud.Object storing a simple todo item may contain the following data:

title:      "Email Linda to Confirm Appointment",
isComplete: false,
priority:   2,
tags:       ["work", "sales"]

Data Types

leancloud.Object supports a wide range of data types to be used for each field, including common ones like String, Number, Boolean, Object, Array, Date, and null. You can nest objects in JSON format to store more structured data within a single Object or Array field.

Special data types supported by leancloud.Object include Pointer and File, which are used to store a reference to another leancloud.Object and binary data respectively.

leancloud.Object also supports GeoPoint, a special data type you can use to store location-based data. See GeoPoints for more details.

Some examples:

from datetime import datetime

# Declare a class
TestObject = leancloud.Object.extend('TestObject')

# Create an object
test_object = TestObject()
test_object.set('testString',  'work')
test_object.set('testInt',     108)
test_object.set('testFloat',   1.890)
test_object.set('testBoolean', True)
test_object.set('testList',    [1, 2, [3, 4, 'string']])
test_object.set('testDict',    {'item1': 12, 'item2': 'string', 'item3': [1, 2, '3']})
test_object.set('testDate',    datetime.now())
test_object.save()

We do not recommend storing large pieces of binary data like images or documents with leancloud.Object using byte[]. The size of each leancloud.Object should not exceed 128 kilobytes. We recommend using leancloud.File for storing images, documents, and other types of files. To do so, create leancloud.File objects and assign them to fields of leancloud.Object. See Files for details.

To learn about how you can protect the data stored on LeanCloud, see Data and Security.

Creating Objects

The code below creates a new instance of leancloud.Object with class Todo:

# Create a new subclass of leancloud.Object
Todo = leancloud.Object.extend('Todo')

# Create a new instance of that class
todo = Todo()

The constructor takes class name as a parameter so that the cloud knows the class you are using to create the object. A class in LeanCloud is comparable to a table in a relational database. A class name starts with a letter and can only contain numbers, letters, and underscores.

Saving Objects

The following code saves a new object with class Todo to the cloud:

# Declare a class
Todo = leancloud.Object.extend('Todo')

# Create an object
todo = Todo()

# Set values of fields
todo.set('title', 'Sign up for Marathon')
todo.set('priority', 2)

# Save the object to the cloud
todo.save()

To make sure the object is successfully saved, take a look at Dashboard > LeanStorage > Data > Todo in your app. You should see a new entry of data with something like this when you click on its objectId:

{
  "title":     "Sign up for Marathon",
  "priority":  2,
  "ACL": {
    "*": {
      "read":  true,
      "write": true
    }
  },
  "objectId":  "582570f38ac247004f39c24b",
  "createdAt": "2017-11-11T07:19:15.549Z",
  "updatedAt": "2017-11-11T07:19:15.549Z"
}

There are several built-in fields that are provided by default which you don't need to specify in your code:

Built-in Field	Type	Description
objectId	str	A unique identifier for each saved object.
ACL	leancloud.ACL	Access Control List, a special object defining the read and write permissions of other people.
createdAt	datetime.datetime	The time the object was created.
updatedAt	datetime.datetime	The time the object was last modified.

Each of these fields is filled in by the cloud automatically and doesn't exist on the local leancloud.Object until a save operation has been completed.

Field names, or keys, can only contain letters, numbers, and underscores. A custom key can neither start with double underscores __, nor be identical to any system reserved words or built-in field names (ACL, className, createdAt, objectId, and updatedAt) regardless of letter cases.

Values can be strings, numbers, booleans, or even arrays and dictionaries — anything that can be JSON-encoded. See Data Types for more information.

We recommend that you adopt CamelCase naming convention to NameYourClassesLikeThis and nameYourKeysLikeThis, which keeps your code more readable.

Retrieving Objects

If leancloud.Object is already in the cloud, you can retrieve it using its objectId with the following code:

Todo = leancloud.Object.extend('Todo')
query = Todo.query
todo = query.get('582570f38ac247004f39c24b')

# todo is the instance of the Todo object with objectId 582570f38ac247004f39c24b
title      = todo.get('title')
priority   = todo.get('priority')

# Acquire special properties
object_id  = todo.id
update_at  = todo.updated_at
created_at = todo.created_at

After retrieving an object, you can use the get method to acquire the data stored in its fields. Be aware that objectId, updatedAt, and createdAt are 3 special properties that cannot be retrieved using the get method or modified with the set method. Each of these fields is filled in by the cloud only, so they don't exist on leancloud.Object until a save operation has been completed.

If you try to access a field or property that doesn't exist, the SDK will not raise an error. Instead, it will return None.

Refreshing Objects

If you need to refresh a local object with the latest version of it in the cloud, call the fetch method on it:

Todo = leancloud.Object.extend('Todo')
todo = Todo.create_without_data('582570f38ac247004f39c24b')
todo.fetch()

Updating Objects

To update an existing object, assign the new data to each field and call the save method. For example:

Todo = leancloud.Object.extend('Todo')
todo = Todo.create_without_data('582570f38ac247004f39c24b')
todo.set('content', 'Weekly meeting has been rescheduled to Wed 3pm for this week.')
todo.save()

LeanCloud automatically figures out which data has changed and only the fields with changes will be sent to the cloud. The fields you didn't update will remain intact.

Updating Data Conditionally

By passing in a query option when saving, you can specify conditions on the save operation so that the object can be updated atomically only when those conditions are met. If no object matches the conditions, the cloud will return error 305 to indicate that there was no update taking place.

For example, in the class Account there is a field called balance, and there are multiple incoming requests that want to modify this field. Since an account cannot have a negative balance, we can only allow a request to update the balance when the amount requested is lower than or equal to the balance:

Account = leancloud.Object.extend('Account')
account = Account.create_without_data('5745557f71cfe40068c6abe0')
# Atomically decrease balance by 100
amount = -100
account.increment('balance', amount)
# Add the condition
where = Account.query.greater_than_or_equal_to('balance', -amount)
# Return the latest data in the cloud upon completion.
# All the fields will be returned if the object is new,
# otherwise only fields with changes will be returned.
account.fetch_when_save = True
try:
    account.save(where=where)
    print('Balance: ', account.get('balance'))
except leancloud.LeanCloudError as e:
    if e.code == 305:
        print('Insufficient balance. Operation failed!')
    else:
        raise

query option only works for existing objects. In other words, it has no effect on objects that haven't been saved to the cloud yet.

The benefit of using query option instead of combining leancloud.Query and leancloud.Object shows up when you have multiple clients trying to update the same field at the same time. The latter way is more cumbersome and may lead to potential inconsistencies.

Updating Counters

Take Twitter as an example, we need to keep track of how many Likes and Retweets a tweet has gained so far. Since a Like or Retweet action can be triggered simultaneously by multiple clients, saving objects with updated values directly can lead to inaccurate results. To make sure that the total number is stored correctly, LeanCloud allows you to atomically increase (or decrease) the value of a number field:

post.increment('likes', 1)

You can specify the amount of increment (or decrement) by providing an additional argument. If the argument is not provided, 1 is used by default.

Updating Arrays

There are several operations that can be used to atomically update an array associated with a given key:

• add()
  appends the given object to the end of an array.
• add_unique()
  adds the given object into an array only if it is not in it. The object will be inserted at a random position.
• remove()
  removes all instances of the given object from an array.

For example, Todo has a field named alarms for keeping track of times at which a user wants to be alerted. The following code adds the times to the alarms field:

from datetime import datetime

alarm1 = datetime(2018, 4, 30, 7, 10, 00)
alarm2 = datetime(2018, 4, 30, 7, 20, 00)
alarm3 = datetime(2018, 4, 30, 7, 30, 00)

Todo = leancloud.Object.extend('Todo')
todo = Todo()
todo.add_unique('alarms', alarm1)
todo.add_unique('alarms', alarm2)
todo.add_unique('alarms', alarm3)
todo.save()

Deleting Objects

The following code deletes a Todo object from the cloud:

Todo = leancloud.Object.extend('Todo')
todo = Todo.create_without_data('582570f38ac247004f39c24b')
todo.destroy()

Batch Processing

You can create, save, delete, or fetch multiple objects within a single request:

# Batch create and update
leancloud.Object.save_all(list_of_objects)

# Batch delete
leancloud.Object.destroy_all(list_of_objects)

The following code sets isComplete of all Todo objects to be true:

Todo = leancloud.Object.extend('Todo')
# Get a collection of todos to work on
todo1 = Todo()
todo2 = Todo()
todo3 = Todo()
# Update value
todo1.set('isComplete', True)
todo2.set('isComplete', True)
todo3.set('isComplete', True)
# Save all at once
Todo.save_all([todo1, todo2, todo3])

Although each function call sends multiple operations in one single network request, saving operations and fetching operations are billed as separate API calls for each object in the collection, while deleting operations are billed as a single API call.

Data Models

Objects may have relationships with other objects. For example, in a blogging application, a Post object may have relationships with many Comment objects. LeanCloud supports three kinds of relationships, including one-to-one, one-to-many, and many-to-many.

One-to-One and One-to-Many Relationships

One-to-one and one-to-many relationships are modeled by saving leancloud.Object as a value in the other object. For example, each Comment in a blogging app might correspond to one Post.

The following code creates a new Post with a single Comment:

# Create a post
Post = leancloud.Object.extend('Post')
post = Post()
post.set('title', 'I am starving!')
post.set('content', 'Hmmm, where should I go for lunch?')

# Create a comment
Comment = leancloud.Object.extend('Comment')
comment = Comment()
comment.set('content', 'KFC is the best!')

# Add the post as a property of the comment
comment.set('parent', post)

# This will save both post and comment
comment.save()

Internally, the backend will store the referred-to object with the Pointer type in just one place in order to maintain consistency. You can also link objects using their objectIds like this:

Post = leancloud.Object.extend('Post')
post = Post.create_without_data('57328ca079bc44005c2472d0')
comment.set('post', post)

See Relational Queries for instructions on how to query relational data.

Many-to-Many Relationships

The easiest way to model many-to-many relationships is to use arrays. In most cases, using arrays helps you reduce the number of queries you need to make and leads to a better performance. However, if additional properties need to be attached to the relationships between two classes, using join tables would be a better choice. Keep in mind that the additional properties are used to describe the relationships between classes rather than any single class.

We recommend you to use join tables if the total amount of objects of any class exceeds 100.

Queries

We've already seen how you can retrieve a single object from the cloud with leancloud.Object, but it doesn't seem to be powerful enough when you need to retrieve multiple objects that match certain conditions at once. In such situation, leancloud.Query would be a more efficient tool you can use.

Basic Queries

The general steps of performing a basic query include:

1. Creating leancloud.Query.
2. Putting conditions on it.
3. Retrieving an array of objects matching the conditions.

The code below retrieves all Student objects whose lastName is Smith:

Student = leancloud.Object.extend('Student')
query = Student.query
query.equal_to('lastName', 'Smith')
student_list = query.find()

Query Constraints

There are several ways to put constraints on the objects found by leancloud.Object.

The code below filters out objects with Jack as firstName:

query.not_equal_to("firstName", 'Jack')

For sortable types like numbers and strings, you can use comparisons in queries:

# Restricts to age < 18
query.less_than('age', 18)

# Restricts to age <= 18
query.less_than_or_equal_to('age', 18)

# Restricts to age > 18
query.greater_than('age', 18)

# Restricts to age >= 18
query.greater_than_or_equal_to('age', 18)

You can apply multiple constraints to a single query, and objects will only be in the results if they match all of the constraints. In other words, it's like concatenating constraints with AND:

query.equal_to("firstName", 'Jack')
query.greater_than('age', 18)

You can limit the number of results by setting limit (defaults to 100):

# Limit to at most 10 results
query.limit(10)

If you need exactly one result, you may use first for convenience:

Todo = leancloud.Object.extend('Todo')
query = Todo.query
query.equal_to('priority', 2)
todo = query.first()

You can skip certain number of results by setting skip:

# Skip the first 20 results
query.skip(20)

You can implement pagination in your app by using skip together with limit:

Todo = leancloud.Object.extend('Todo')
query = Todo.query
query.equal_to('priority', 2)
query.limit(10)
query.skip(20)

For sortable types, you can control the order in which results are returned:

# Sorts the results in ascending order by the createdAt property
query.ascending('createdAt')

# Sorts the results in descending order by the createdAt property
query.descending('createdAt')

You can even attach multiple sorting rules to a single query:

query.add_ascending('createdAt')
query.add_descending('priority')

To retrieve objects that have or do not have particular fields:

# Finds objects that have the 'images' field
query.exists('images')

# Finds objects that don't have the 'images' field
query.does_not_exist('images')

You can restrict the fields returned by providing a list of keys with select. The code below retrieves todos with only the title and content fields (and also special built-in fields such as objectId, createdAt, and updatedAt):

Todo = leancloud.Object.extend('Todo')
query = Todo.query
query.select('title', 'content')
todo = query.first()

title = todo.get('title') # √
content = todo.get('content') # √
notes = todo.get('notes') # None

The unselected fields can be fetched later with fetch. See Refreshing Objects.

Queries on String Values

Use startswith to restrict to string values that start with a particular string. Similar to a LIKE operator in SQL, it is indexed so it is efficient for large datasets:

Todo = leancloud.Object.extend('Todo')
query = Todo.query
# SQL equivalent: title LIKE 'lunch%'
query.startswith("title", "lunch")

Use contains to restrict to string values that contain a particular string:

Todo = leancloud.Object.extend('Todo')
query = Todo.query
# SQL equivalent: title LIKE '%lunch%'
query.contains("title", "lunch")

Unlike startswith, contains can't take advantage of indexes, which is not encouraged to be used for large datasets.

If you are looking for string values that do not contain a particular string, use matched with regular expressions:

Todo = leancloud.Object.extend('Todo')
query = Todo.query
# 'title' without 'ticket' (case-insensitive)
query.matched('title', '^((?!ticket).)*$')

However, performing queries with regular expressions as constraints can be very expensive, especially for classes with over 100,000 records. The reason behind is that queries like this can't take advantage of indexes and will lead to exhaustive scanning of the whole dataset to find the matching objects. We recommend that you take a look at our In-App Searching feature, a full-text search solution we provide to improve your app's searching ability and user experience.

Queries on Array Values

The code below looks for all the objects with work as an element of its array field tags:

query.equal_to('tags', 'work')

You can also look for objects whose array field tags contains work, sales, and appointment:

query.contains_all('tags', ['work', 'sales', 'appointment'])

To retrieve objects whose field matches any one of the values in a given list, you can use contained_in instead of performing multiple queries. The code below constructs a query that retrieves todo items with priority to be 1 or 2:

# Single query
Todo = leancloud.Object.extend('Todo')
priority_one_or_two = Todo.query
priority_one_or_two.contained_in('priority', [1, 2])
# Mission completed :)

# ---------------
#       vs.
# ---------------

# Multiple queries
Todo = leancloud.Object.extend('Todo')

priority_one = Todo.query
priority_one.equal_to('priority', 1)

priority_two = Todo.query
priority_two.equal_to('priority', 2)

priority_one_or_two = leancloud.Query.or_(priority_one, priority_two)
# Kind of verbose :(

Conversely, you can use not_contained_in if you want to retrieve objects that do not match any of the values in a list.

Relational Queries

There are several ways to perform queries for relational data. To retrieve objects whose given field matches a particular leancloud.Object, you can use equal_to just like how you use it for other data types. For example, if each Comment has a Post object in its post field, you can fetch all the comments for a particular Post with the following code:

Post = leancloud.Object.extend('Post')
post = Post.create_without_data('57328ca079bc44005c2472d0')
query = leancloud.Query('Comment')
query.equal_to('post', post)
comment_list = query.find()

To retrieve objects whose given field contains leancloud.Object that matches a different query, you can use matches_query. The code below constructs a query that looks for all the comments for posts with images:

inner_query = leancloud.Query('Post')
inner_query.exists('images')

query = leancloud.Query('Comment')
query.matches_query('post', inner_query)

To retrieve objects whose given field does not contain leancloud.Object that matches a different query, use does_not_match_query instead.

Sometimes you may need to look for related objects from different classes without extra queries. In such situations, you can use include on the same query. The following code retrieves the last 10 comments together with the posts related to them:

query = leancloud.Query('Comment')

# Retrieve the most recent ones
query.add_descending('createdAt')

# Only retrieve the last 10
query.limit(10)

# Include the related post together with each comment
query.include('post')

comment_list = query.find()
for comment in comment_list:
    # This does not require a network access
    post = comment.get('post')

You can even indicate multi-level associations using dot notations. If you wanted to include the post for each comment as well as the author of the post, you can do:

query.include('post.author')

Feel free to use include as many times as you need for the same query to have multiple fields included. Related objects retrieved in this way also works with leancloud.Query helpers like first and get.

You can also use dot notations with select to limit the fields returned from the related objects:

query.select('post.author.firstName')

Caveats about Relational Queries

The backend of LeanCloud is not built on relational databases, which makes it impossible to join tables while querying. For the relational queries mentioned above, what LeanCloud would do is to first perform an inner query (with 100 as default limit and 1000 as maximum) and then insert the result from this query into the outer query. If the number of records matching the inner query exceeds the limit and the outer query contains other constraints, the amount of the records returned in the end could be zero or less than your expectation since only the records within the limit would be inserted into the outer query.

The following actions can be taken to solve the problem:

• Make sure the number of records in the result of the inner query is no more than 100. If it is between 100 and 1,000, set 1000 as the limit of the inner query.
• Create redundancy for the fields being queried by the inner query on the table for the outer query.
• Repeat the same query with different skip values until all the records are gone through (performance issue could occur if the value of skip gets too big).

Counting Objects

If you just need to count how many objects match a query but do not need to retrieve the actual objects, use count instead of find. For example, to count how many todos have been completed:

Todo = leancloud.Object.extend('Todo')
query = Todo.query
query.equal_to('isComplete', True)
count = query.count()

Compound Queries

Compound queries can be used if complex query conditions need to be specified. A compound query is a logical combination (OR or AND) of subqueries.

OR-ed Query Constraints

An object will be returned as long as it fulfills any one of the subqueries. The code below constructs a query that looks for all the todos that either have priorities higher than or equal to 3, or are already completed:

Todo = leancloud.Object.extend('Todo')

priority_query = Todo.query
priority_query.greater_than_or_equal_to('priority', 3)

is_complete_query = Todo.query
is_complete_query.equal_to('isComplete', True)

query = leancloud.Query.or_(priority_query, is_complete_query)

AND-ed Query Constraints

The effect of using AND-ed query is the same as adding constraints to leancloud.Query. The code below constructs a query that looks for all the todos that are created between 2016-11-13 and 2016-12-02:

from datetime import datetime

Todo = leancloud.Object.extend('Todo')

start_date_query = Todo.query
start_date_query.greater_than_or_equal_to('createdAt', datetime(2016, 11, 13))

end_date_query = Todo.query
end_date_query.less_than('createdAt', datetime(2016, 12, 3))

query = leancloud.Query.and_(start_date_query, end_date_query)

While using an AND-ed query by itself doesn't bring anything new comparing to a basic query, combining AND-ed queries with OR-ed queries together allows you to implement complicated query conditions in your program. The code below constructs a query that looks for all the todos created today that either have no location set or have 3 as priority:

from datetime import datetime

Todo = leancloud.Object.extend('Todo')

created_at_query = Todo.query
created_at_query.greater_than_or_equal_to('createdAt', datetime(2018, 4, 30))
created_at_query.less_than('createdAt', datetime(2018, 5, 1))

location_query = Todo.query
location_query.does_not_exist('location')

priority_query = Todo.query
priority_query.equal_to('priority', 3)

or_query = leancloud.Query.or_(location_query, priority_query)
query = leancloud.Query.and_(created_at_query, or_query)

Optimizing Performance

There are several factors that could lead to potential performance issues when you conduct a query, especially when more than 100,000 records are returned at a time. We are listing some common ones here so you can design your apps accordingly to avoid them:

• Querying with "not equal to" or "not include" (index will not work)
• Querying on strings with a wildcard at the beginning of the pattern (index will not work)
• Using count with conditions (all the entries will be gone through)
• Using skip for a great number of entries (all the entries that need to be skipped will be gone through)
• Sorting without index (querying and sorting cannot share a composite index unless the conditions used on them are both covered by the same one)
• Querying without index (the conditions used on the query cannot share a composite index unless all of them are covered by the same one; additional time will be consumed if excessive data falls under the uncovered conditions)

Files

leancloud.File allows you to store application files in the cloud that would otherwise be too large or cumbersome to fit into a regular leancloud.Object. The most common use case is storing images, but you can also use it for documents, videos, music, and any other binary data.

Creating Files

You can create a file from a string:

from StringIO import StringIO

data = StringIO('LeanCloud')
# resume.txt is the file name
file = leancloud.File('resume.txt', data)

You can also create a file from byte values with buffer:

data = buffer('\x4c\x65\x61\x6e\x43\x6c\x6f\x75\x64')
file = leancloud.File('resume.txt', data)

You can also create a file from a URL:

file = leancloud.File.create_with_url('logo.png', 'https://leancloud.cn/assets/imgs/press/Logo%20-%20Blue%20Padding.a60eb2fa.png')

LeanCloud will auto-detect the type of the file you are uploading based on the file extension, but you can also specify the Content-Type (commonly referred to as MIME type):

file = leancloud.File('resume.txt', StringIO('{"company":"LeanCloud"}'), 'application/json')

But the most common method for creating files is to upload them from local paths:

with open('/tmp/avatar.jpg', 'rb') as f:
    file = leancloud.File('avatar.jpg', f)

The file we uploaded here is named avatar.jpg. There are a couple of things to note here:

• Each file uploaded will get its unique objectId, so it is allowed for multiple files to share the same name.
• A correct extension needs to be assigned to each file which the cloud will use to infer the type of a file. For example, if you are storing a PNG image with leancloud.File, use .png as its extension.
• If the file doesn't have an extension and the content type is not specified, LeanCloud defaults the file's type to be application/octet-stream.

Saving Files

By saving a file, you store it into the cloud and get a permanent URL pointing to it:

file.save()

You can associate a file with leancloud.Object after it is saved:

Todo = leancloud.Object.extend('Todo')
todo = Todo()
todo.set('title', 'Get Cakes')
# attachments is an Array field
todo.add('attachments', file)
todo.save()

File Metadata

When uploading a file, you can attach additional properties to it with metaData. A file's metaData cannot be updated once the file is stored to the cloud.

# Set metadata
file.metadata['author'] = 'LeanCloud'
file.save()

# Get all metadata
metadata = file.metadata
# Get author
author = metadata['author']
# Get file name
file_name = file.name
# Get size (not available for files created from base64-encoded strings or URLs)
size = file.size

Deleting Files

The code below deletes a file from the cloud:

file = leancloud.File.create_without_data('552e0a27e4b0643b709e891e')
file.destroy()

Enabling HTTPS

If you demand that the files in the cloud should be accessed through HTTPS, check on Enable HTTPS domain in Dashboard > LeanStorage > Settings > Custom domain for files. There is no free quota on using HTTPS for files and you will see the pricing once the function is enabled.

After enabling HTTPS, the URLs of the files previously stored in the _File table will be converted to HTTPS. If you disable the function, the URLs being converted will not change back.

LeanMessage stores files sent through messages with leancloud.File and the URLs of the files will be included in the messages. After HTTPS is enabled, the URLs of the files sent in the past messages will not be automatically converted like what happens in _File.

Setting up Custom Domain

LeanCloud offers a shared domain for all the apps to access the files stored in the cloud. However, due to the Cyber Security Law of the countries where we offer our services, the shared domain might not be available all the time. We highly recommend that you set up your custom domains for accessing files so that your apps will not be affected when the shared domain becomes unavailable. You can set up custom domains at Dashboard > LeanStorage > Settings > Custom domain for files.

The setup of custom domains is irreversible. You cannot unbind domains, but you can change the domains at any time.

When binding domains, you can choose if you want to enable HTTPS:

• If you don't enable HTTPS, clients can only access files via HTTP.
• If you enable HTTPS, clients can access files via both HTTPS and HTTP.

CDN Support

You can set up your own CDN to improve the speed your users access the files stored on LeanCloud. Take Amazon CloudFront CDN as an example:

1. Read Getting Started with CloudFront.
2. Create an Amazon AWS account, and choose a CloudFront subscription plan that suits your business.
3. LeanCloud has got S3's read permission properly configured, so you can skip Step 2: Upload your content to Amazon S3 and grant object permissions in the guide and proceed with other steps.
4. Take the domain name from the URL of your leancloud.File and fill it into CloudFront's Origin Domain Name. Leave the other settings with defaults.

GeoPoints

LeanCloud allows you to associate real-world latitude and longitude coordinates with an object by adding leancloud.GeoPoint to the leancloud.Object. By doing so, queries on the proximity of an object to a given point can be performed, allowing you to easily implement functions like looking for users or places nearby.

To associate a point with an object, you need to create the point first. The code below creates leancloud.GeoPoint with 39.9 as latitude and 116.4 as longitude:

point = leancloud.GeoPoint(39.9, 116.4)

Now you can store the point in an object as a regular field:

todo.set('location', point)

Geo Queries

With a number of existing objects with spatial coordinates, you can find out which of them are closest to a given point, or are contained within a particular area. This can be done by adding another restriction to leancloud.Query using near. The code below returns a list of Todo objects with location closest to a given point:

query = leancloud.Query('Todo')
point = leancloud.GeoPoint(39.9, 116.4)
query.near('location', point)

# Limit to 10 results
query.limit(10)
todo_list = query.find()

To have the results limited within a certain distance, check out within_kilometers, within_miles, and within_radians in our API docs.

You can also query for the set of objects that are contained within a rectangular bounding box with within_geo_box:

query = leancloud.Query('Todo')
southwest = leancloud.GeoPoint(30, 115)
northeast = leancloud.GeoPoint(40, 118)
query.within_geo_box('location', southwest, northeast)

Caveats about GeoPoints

There are a couple of things to keep in mind:

• Each leancloud.Object may only have one field containing leancloud.GeoPoint object.
• Points should not exceed the extreme ends of the ranges. Latitude should be between -90.0 and 90.0. Longitude should be between -180.0 and 180.0. Attempting to set latitude or longitude out of bounds will cause an error.

Users

At the core of many apps, there is a notion of user accounts that allows users to access their information in a secure manner. We provide a specialized user class called leancloud.User which automatically handles much of the functionality required for user account management in your app.

leancloud.User is a subclass of leancloud.Object. Therefore, all the methods that work for leancloud.Object also work for leancloud.User. The only difference is that leancloud.User has some additional features specific to user accounts. Each app has a dedicated _User class for storing leancloud.User.

User Properties

leancloud.User offers the following fields that leancloud.Object does not have:

• username: The username of the user.
• password: The password of the user.
• email: The email address of the user.
• emailVerfied: Whether the user has verified the email address with LeanCloud or not.
• mobilePhoneNumber: The mobile phone number of the user.
• mobilePhoneVerfied: Whether the user has verified the mobile phone number with LeanCloud or not.

We'll go through each of these in detail as we run through the various use cases for users.

Signing up

When a user first opens your app, you may want them to sign up for an account. The following code shows a typical sign-up process with username and password:

# Create an instance
user = leancloud.User()

# Same as user.set('username', 'Tom')
user.set_username('Tom')
user.set_password('cat!@#123')

# Optional
user.set_email('tom@leancloud.rocks')
user.set_mobile_phone_number('+19490008888')

# Other fields can be set in the same way as leancloud.Object
user.set('gender', 'secret')

user.sign_up()

If the code returns the error 202, it means that a user with the same username already exists in _User table and the client should prompt the user to try a different username. It is also required that each email or mobilePhoneNumber appears only once in the corresponding column, otherwise error 203 or 214 will occur. You may ask a user to sign up with an email address and make the username to be the same as the email. By doing so, the user can directly reset their password with email.

Signing up with Phones

For a mobile app, it's also common to ask users to sign up with their phone numbers instead of usernames and passwords. There are two basic steps in it. First, ask the user to enter a phone number that can receive text messages. When the user clicks on the "Get Verification Code" button, call the following method to have a 6-digit verification code sent to the phone number the user just entered:

leancloud.cloudfunc.request_sms_code('+19490008888')

After the verification code is entered by the user, call the following method to finish signing up:

leancloud.User.signup_or_login_with_mobile_phone('+19490008888', '123456')

Phone Number Format

A phone number that leancloud.User accepts should have a leading plus sign (+) immediately followed by the country code and the phone number without any dashes, spaces, or other non-numeric characters. For instance, +8618200008888 is a valid China number (86 is the country code) and +19490008888 is a valid US or Canada number (1 is the country code).

For a list of countries and regions that LeanCloud can reach out through SMS, please refer to the Pricing section of the SMS guide.

Logging in

The code below logs a user in with username and password:

leancloud.User.login(username='Tom', password='cat!@#123')

Logging in with Emails

The code below logs a user in with email and password:

leancloud.User.login(email='tom@leancloud.rocks', password='cat!@#123')

Logging in with Phones

If you are allowing users to sign up with their phone numbers, you can also let them log in with either a password or a verification code sent via text message. The code below logs a user in with phone number and password:

leancloud.User.login_with_mobile_phone('+19490008888', 'cat!@#123')

You may also let a user in with a verification code sent to their phone, which is useful when the user forgets the password and does not want to reset it at the moment. Similar to the steps of signing a user up with phone numbers, ask the user to enter the phone number associated with the account, and call the following method once the user clicks on the "Get Verification Code" button:

leancloud.User.request_login_sms_code('+19490008888')

After the verification code is entered by the user, call the following method to finish logging in:

leancloud.User.signup_or_login_with_mobile_phone('+19490008888', '123456')

Sandbox Phone Number

During the development of your application, you may need to test the sign-up or log-in related API intensively with your phone. As there are, however, limits to how quickly messages can be sent into the carrier networks, your testing pace can be greatly affected.

To work around it, you can set up a sandbox phone number in Dashboard > Messaging > SMS > Settings. LeanCloud will issue a fixed verification code to go with that sandbox phone number. Whenever LeanCloud detects such combination of data, the user will be let right in authenticated without any connections to the carrier networks being made.

On a related note, a sandbox phone number also comes in handy for iOS apps that allow users to log in with SMS code. This is because Apple may ask developers to provide a fixed combination of phone number and verification code for them to review the app as a normal user. Failure to do so may result in their app being rejected by App Store.

For more details regarding limitations of sending and receiving SMS messages, see SMS Guide.

Single Device Sign-on

In some scenarios you may want to restrict a user's account to be logged on by no more than one device at a time, that is, when a user logs in to the app on a new device, all the previous sessions on other devices will become invalid. Here's the instruction about how you can implement this feature with LeanCloud:

1. Create a new class that keeps track of each user's credentials and their device information.
2. Each time when a user logs in on a device, update the device information of this user to be the current device.
3. When the app running on another device is opened, check if the device matches the one stored in the cloud. If it does not, log the user out.

User Account Lockout

If the wrong password or verification code is entered for an account for more than 6 times within 15 minutes, the account will be disabled temporarily and the error { "code": 1, "error": "You have exceeded the maximum number of login attempts, please try again later, or consider resetting your password." } will be returned.

The account will be automatically recovered 15 minutes after the last attempt and the process cannot be expedited through SDK or REST API. While the account is disabled, the user cannot be logged in even though the correct credentials are provided. The restriction applies to both client-side SDKs and LeanEngine.

Verifying Emails

You can request that your users have their email addresses verified before they can log in or access certain functions in your app. This makes it harder for spam users to abuse your app. By default, each user has an emailVerified field which becomes false when the user first signs up or has their email address changed. In your app's Dashboard > LeanStorage > Settings, you can enable Send verification emails when users register or change email addresses from clients so that when a user signs up or changes their email address, an email containing a verification link will be sent out automatically. You can find the option to prevent users with unverified email addresses from logging in on the same page.

If a user forgets to click on the link and needs to have their account verified later, the following code can be used to send a new email:

leancloud.User.request_email_verify('tom@leancloud.rocks')

The emailVerified will become true after the link is clicked on. This field can never be true when the email field is empty.

Verifying Phone Numbers

Similar to Verifying Emails, you can also request that your users have their phone numbers verified before they can log in or access certain functions in your app. By default, each user has a mobilePhoneVerified field which becomes false when the user first signs up or has their phone number changed. In your app's Dashboard > LeanStorage > Settings, you can enable Send verification SMS when users register or change phone numbers from clients so that when a user signs up or changes their phone number, a text message containing a verification code will be sent out automatically. You can find the option to prevent users with unverified phone numbers from logging in on the same page.

You can also initiate a verification request at anytime with the following code:

leancloud.User.request_mobile_phone_verify('+19490008888')

After the verification code is entered by the user, call the following method and the user's mobilePhoneVerified will become true:

leancloud.User.verify_mobile_phone_number('123456')

Current User

After a user is logged in, LeanCloud SDK automatically stores the session information of this user in the client so that the user does not need to log in each time they open the client. The following code checks if there is a user logged in:

current_user = leancloud.User.get_current()
if current_user is not None:
    # Redirect to the home page
    pass
else:
    # Show the sign-up or log-in page
    pass

The session information of a user will remain in the client until the user is logged out:

leancloud.User.logout()

# current_user becomes None
current_user = leancloud.User.get_current()

Setting The Current User

A session token will be returned to the client after a user is logged in. It will be cached by our SDK and will be used for authenticating requests made by the same leancloud.User in the future. The session token will be included in the header of each HTTP request made from the client, which helps the cloud identify the leancloud.User sending the request.

Below are the situations when you may need to log a user in with session token:

• A session token is already cached on the client which can be used to automatically log the user in (you can use leancloud.User.get_current().get_session_token() to get the session token of the current user).
• A WebView within the app needs to know the current user.
• The user is logged in on the server side using your own authentication routines and the server is able to provide the session token to the client.

The code below logs a user in with session token (the session token will be validated before proceeding):

leancloud.User.become('anmlwi96s381m6ca7o7266pzf')

The code below checks if a session token is valid:

authenticated = leancloud.User.get_current().is_authenticated()
if authenticated:
    # The session token is valid
    pass
else:
    # The session token is invalid
    pass

Resetting Passwords

It's quite common for the users of an app to forget their passwords. LeanCloud provides a number of ways for them to reset their passwords.

Here is the flow of resetting password with email:

1. The user enters the email address used for the account.
2. LeanCloud sends an email to the address including a link for resetting password.
3. After the user clicks on the link, a new page will pop up, asking for a new password.
4. The password will be reset after the user enters a new password.

To start with, ask the user to enter the email used for the account, and call the function below:

leancloud.User.request_password_reset('tom@leancloud.rocks')

The code above will check if there is a user in the _User table that has the email to be the same as the one provided, and will send them a password reset email if so. As mentioned previously, you can make the username of each user to be the same as their email, or collect the email separately and store it in the email field.

Alternatively, you can ask for the mobile phone number instead of the email to reset their password:

1. The user enters the mobile phone number used for the account.
2. LeanCloud sends a short message to the number including a verification code.
3. The user types in the verification code and a new password.

The code below sends a verification code to a number:

leancloud.User.request_password_reset_by_sms_code('+19490008888')

The code above will check if there is a user in the _User table that has the mobilePhoneNumber to be the same as the one provided, and will send them a verification code if so.

The code below resets the password of a user after they enter the verification code and a new password:

leancloud.User.reset_password_by_sms_code('123456', 'cat!@#123')

Queries on Users

To query for users, you can simple create a new leancloud.Query for _User:

user_query = leancloud.Query('_leancloud.User')

For security reasons, the _User table of each new app has its find permission disabled by default. Each user can only access their own data in _User table and cannot access that of others. If you need to allow each user to view other users' data, we recommend that you create a new table to store such data and enable the find permission of this table. You may also encapsulate queries on users within LeanEngine and avoid opening up find permissions of _User tables.

See Security of User Objects for other restrictions applied to the _User table, and Data and Security for more information regarding class-level permission settings.

Associations

Associations involving leancloud.User works in the same way as basic leancloud.Object. The code below saves a new book for an author and retrieves all the books written by that author:

Book = leancloud.Object.extend('Book')
book = Book()
author = leancloud.User.get_current()
book.set('title', 'My Fifth Book')
book.set('author', author)
book.save()

# Find all the books by the same author
query = Book.query
query.equal_to('author', author)
book_list = query.find()

Security of User Objects

The leancloud.User class is secured by default. You are not able to invoke any save- or delete-related methods unless the leancloud.User was obtained using an authenticated method like login or sign_up. This ensures that each user can only update their own data.

The reason behind is that most data stored in leancloud.User can be very personal and sensitive, such as mobile phone number, social network account ID, etc. Even the app's owner should avoid tampering with these data for the sake of user's privacy.

The code below illustrates this security policy:

leancloud.User.login('Tom', 'cat!@#123')
current_user = leancloud.User.get_current()

# Attempt to change username
current_user.set('username', 'Jerry')
# Password is hashed and an empty string will be returned
password = current_user.get('password')
# This will work since the user is authenticated
current_user.save()

# Get the user with a non-authenticated method
query = leancloud.Query('_User')
unauthenticated_user = query.get(current_user.id)
unauthenticated_user.set('username', 'Toodle')
# This will cause error since the user is unauthenticated
unauthenticated_user.save()

The leancloud.User obtained from leancloud.User.get_current() will always be authenticated.

To check if leancloud.User is authenticated, you can invoke the is_authenticated method. You do not need to check if leancloud.User is authenticated if it is obtained via an authenticated method.

As a reminder, the user's password can be set when signing up but cannot be modified and saved to the cloud afterwards unless the user requests it to be reset. It will not be cached on the client and will show as null when being retrieved from the cloud after the user is logged in.

Security of Other Objects

For each given object, you can specify which users are allowed to read it and which are allowed to modify it. To support this type of security, each object has an access control list, implemented by the leancloud.ACL class. More details can be found in ACL Guide.

Linking Users

LeanCloud allows you to link your users with services like GitHub, Twitter, and Facebook (commonly known as social networking services, or SNS), allowing your users to sign up or log into your application using their existing identities. For example, to sign up or log in with a user's GitHub account, your code will look like this:

LeanCloud then verifies that the provided authData is valid and checks if a user is already associated with it. If so, it returns the status code 200 OK along with the details (including a sessionToken for the user).

If the authData is not linked to any account, you will instead receive the status code 201 Created, indicating that a new user has been created. The body of the response contains objectId, createdAt, sessionToken, and an automatically-generated unique username. For example:

{
  "username":     "k9mjnl7zq9mjbc7expspsxlls",
  "objectId":     "5b029266fb4ffe005d6c7c2e",
  "createdAt":    "2018-05-21T09:33:26.406Z",
  "updatedAt":    "2018-05-21T09:33:26.575Z",
  "sessionToken": "…",
  // By default authData won't show up here
  // See explanations below
  "authData": {
    // …
  }
  // …
}

By default, authData cannot be returned to the client unless the record is owned by the current user. To change this behavior, you can go to your app's Dashboard > LeanStorage > Data > _User, click on the arrow icon on the authData column header, click on Edit, and check off the Only owners can read and write option so that anyone can have access to it.

To ensure that each leancloud.User is linked to each service account only once, a unique index needs to be created for the authData.<SERVICE_NAME>.uid key in the _User class.

Authentication Data

authData is a JSON object with the names of services as keys and the details as values. You are responsible for completing the authentication flow (usually through OAuth 1.0 or 2.0) to obtain the details from the service provider which is required for linking.

A user who has GitHub linked may have the following object as authData:

{
  "github": {
    "uid":           "…",
    "access_token":  "…",
    "expires_in":    7200,
    "refresh_token": "…",
    "scope":         "…"
  }
}

LeanCloud automatically validates the access tokens for certain services to prevent data forge attack. When the validation fails, LeanCloud will respond with invalid authData error and the linking will not be established. For services that are not recognized by LeanCloud, you are responsible for validating access tokens by yourself. You can turn off the Validate access tokens when logging in with third-party accounts option in your app's Dashboard > LeanStorage > Settings if you prefer not to have LeanCloud validate access tokens for you.

Unlinking

You can unlink a service by setting the authData for the service to null. The code below unlinks a user's GitHub account:

Roles

As your app grows in scope and user-base, you may find yourself needing more coarse-grained control over access to pieces of your data than user-linked ACLs can provide. To address this requirement, LeanCloud supports a form of role-based access control. Check the detailed ACL Guide to learn how to set it up for your objects.

In-App Searching

In-App Searching offers a better way to search through the information contained within your apps. It's built with search engine capabilities that you can easily tap into your app. Effective and useful searching functionality in your app is crucial for helping users find what they need. For more details, see In-App Searching Guide.

In-App Socializing

In-app socializing offers features like following, timeline, status update, interaction, messaging, etc. For more details, see In-App Socializing Guide.