photoprism/internal/search/search.go

70 lines
2.1 KiB
Go

/*
Package search performs common index search queries.
Copyright (c) 2018 - 2022 Michael Mayer <hello@photoprism.org>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
PhotoPrism® is a registered trademark of Michael Mayer. You may use it as required
to describe our software, run your own server, for educational purposes, but not for
offering commercial goods, products, or services without prior written permission.
In other words, please ask.
Feel free to send an e-mail to hello@photoprism.org if you have questions,
want to support our work, or just want to say hello.
Additional information can be found in our Developer Guide:
https://docs.photoprism.app/developer-guide/
*/
package search
import (
"github.com/jinzhu/gorm"
"github.com/photoprism/photoprism/internal/entity"
"github.com/photoprism/photoprism/internal/event"
)
var log = event.Log
// MaxResults is max result limit for queries.
const MaxResults = 25000
// Radius is about 1 km.
const Radius = 0.009
// Cols represents a list of database columns.
type Cols []string
// Query searches given an originals path and a db instance.
type Query struct {
db *gorm.DB
}
// Count represents the total number of search results.
type Count struct {
Total int
}
// Db returns a database connection instance.
func Db() *gorm.DB {
return entity.Db()
}
// UnscopedDb returns an unscoped database connection instance.
func UnscopedDb() *gorm.DB {
return entity.Db().Unscoped()
}