This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!
Project Description

Query a daterange on objects with a daterange.

Example: You want all events within a date range of next two weeks, neither if the event has started one week ago nor ends one week later - or both.

Consider objects with a daterange start and end. Use this addon to query all obejcts inside a query-start and query-end range, where either or both of objects start and end match the query range.

This index is possibly the fastest way to solve the problem, it solves it as an zope index and works direct with the catalogs fast IISets (or IFSets). Its much faster than formerly used classical catalog-query post-processing.

There are two types of indexes available:

  • Products.ZCatalog (Zope 2) compatible
  • zope.catalog (Zope (3) framework) compatible

The index acts as an proxy for a more complex query on two indexes (DateIndex on ZCatalog or FieldIndex on zope.catalog). It utilize the other indexes and does not store any index-data itself.

To illustrate this a query example on ZCatalog):

>>> result = zcatalog.search({'myindex': {'start':'2000-10-01 00:00',
...                                       'end':'2010-10-31 23:59'} })

or a query example on zope.catalog:

>>> query = catalog.apply({'myindex': (datetime(2000, 10, 01, 00, 00'),
...                                    datetime(2010, 10, 31, 23, 59'))})

This will find objects (consider start is always before end date):

  1. where start date is before 2000-10-01 and end date is after 2010-10-31.
  2. where start date is between 2000-10-01 and 2010-10-31.
  3. where end date is between 2000-10-01 and 2010-10-31.
  4. where both are between 2000-10-01 and 2010-10-31.

ASCII-Art of the above (q=query, e=event):

Q)    q_start|--------------------|q_end

1) e_start|---------------------------|e_end

2) e_start|---------------|e_end

3)           e_start|-----------------|e_end

4)           e_start|-----|e_end

It’s also possible to configure this indexer through XML. Add a catalog.xml to your profile with the following settings:

    <?xml version="1.0"?>
    <object name="portal_catalog" meta_type="Plone Catalog Tool">

<index name="start_end_range" meta_type="DateRangeInRangeIndex">
    <startindex value="your_custom_start_field_index" />
    <endindex value="your_custom_end_field_index" />
</index>

    </object>

The startindex and endindex nodes define the indexes for the start and end fields of this DateRangeInRangeIndex.

Source Code

The sources are in a GIT DVCS with its main branches at github.

We’d be happy to see many commits, forks and pull-requests to make DateRangeInRangeIndex even better.

Contributors

History

1.3

  • added support for generic setup [SyZn, 2014-01-16]

1.2

  • added zope.catalog compatible index. [jensens, 2012-04-12]

1.1

  • eggification and release at pypi [jensens, 2011-03-08]

1.0

  • final release as Zope Product [jensens, 2007-08-29]

License

Copyright (c) 2007-2012, BlueDynamics Alliance, Austria All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of the BlueDynamics Alliance nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY BlueDynamics Alliance AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BlueDynamics Alliance BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Release History

Release History

1.3

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

1.2

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

1.1

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
Products.DateRangeInRangeIndex-1.3.tar.gz (11.3 kB) Copy SHA256 Checksum SHA256 Source Jan 16, 2014

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting