## engine.DateTimeField


Field which indexes datetimes as Point fields of timestamps.


Usage

``` python
engine.DateTimeField(
    name,
    dimensions=1,
    **settings,
)
```


Supports datetimes, dates, and any prefix of time tuples.


## Methods

| Name | Description |
|----|----|
| [duration()](#duration) | Return date range query within time span of date. |
| [items()](#items) | Generate lucene NumericFields of timestamps. |
| [prefix()](#prefix) | Return range query which matches the date prefix. |
| [range()](#range) | Return NumericRangeQuery of timestamps. |
| [timestamp()](#timestamp) | Return utc timestamp from date or time tuple. |
| [within()](#within) | Return date range query within current time and delta. |

------------------------------------------------------------------------


#### duration()


Return date range query within time span of date.


Usage

``` python
duration(date, days=0, **delta)
```


##### Parameters

| Name | Type | Description | Default |
|----|----|----|----|
| date |  | origin date or tuple days \*\*delta:: timedelta parameters | \- |

------------------------------------------------------------------------


#### items()


Generate lucene NumericFields of timestamps.


Usage

``` python
items(*dates)
```


------------------------------------------------------------------------


#### prefix()


Return range query which matches the date prefix.


Usage

``` python
prefix(date)
```


------------------------------------------------------------------------


#### range()


Return NumericRangeQuery of timestamps.


Usage

``` python
range(start, stop, **inclusive)
```


------------------------------------------------------------------------


#### timestamp()


Return utc timestamp from date or time tuple.


Usage

``` python
timestamp(date)
```


------------------------------------------------------------------------


#### within()


Return date range query within current time and delta.


Usage

``` python
within(days=0, weeks=0, tz=None, **delta)
```


If the delta is an exact number of days, then dates will be used.

##### Parameters

| Name | Type | Description | Default |
|----|----|----|----|
| tz |  | optional timezone \*\*delta: additional timedelta parameters | \- |