Class: ApplicationRecord

Inherits:

ActiveRecord::Base

• Object
• ActiveRecord::Base
• ApplicationRecord

Defined in:

app/models/application_record.rb

Direct Known Subclasses

AbuseReport, AlertManagement::Alert, AlertManagement::AlertAssignee, AlertManagement::HttpIntegration, Alerting::ProjectAlertingSetting, AlertsServiceData, Analytics::CycleAnalytics::ProjectStage, Analytics::InstanceStatistics::Measurement, Appearance, ApplicationSetting, ApplicationSetting::Term, Approval, Atlassian::Identity, AuditEvent, AuditEventPartitioned, AuthenticationEvent, AwardEmoji, Aws::Role, Badge, Board, BoardGroupRecentVisit, BoardProjectRecentVisit, BroadcastMessage, BulkImport, BulkImports::Configuration, BulkImports::Entity, BulkImports::Failure, BulkImports::Tracker, ChatName, ChatTeam, Ci::BuildMetadata, Ci::BuildNeed, Ci::BuildPendingState, Ci::BuildReportResult, Ci::BuildRunnerSession, Ci::BuildTraceChunk, Ci::BuildTraceSection, Ci::BuildTraceSectionName, Ci::DailyBuildGroupReportResult, Ci::DeletedObject, Ci::FreezePeriod, Ci::GroupVariable, Ci::InstanceVariable, Ci::JobArtifact, Ci::JobVariable, Ci::Pipeline, Ci::PipelineArtifact, Ci::PipelineChatData, Ci::PipelineConfig, Ci::PipelineMessage, Ci::PipelineSchedule, Ci::PipelineScheduleVariable, Ci::PipelineVariable, Ci::Ref, Ci::Resource, Ci::ResourceGroup, Ci::Runner, Ci::RunnerNamespace, Ci::RunnerProject, Ci::Sources::Pipeline, Ci::Stage, Ci::TestCase, Ci::TestCaseFailure, Ci::Trigger, Ci::TriggerRequest, Ci::Variable, CiPlatformMetric, Clusters::Agent, Clusters::AgentToken, Clusters::Applications::CertManager, Clusters::Applications::Cilium, Clusters::Applications::Crossplane, Clusters::Applications::ElasticStack, Clusters::Applications::Fluentd, Clusters::Applications::Helm, Clusters::Applications::Ingress, Clusters::Applications::Jupyter, Clusters::Applications::Knative, Clusters::Applications::Prometheus, Clusters::Applications::Runner, Clusters::Cluster, Clusters::Group, Clusters::KubernetesNamespace, Clusters::Platforms::Kubernetes, Clusters::Project, Clusters::Providers::Aws, Clusters::Providers::Gcp, CommitStatus, ContainerExpirationPolicy, ContainerRepository, CustomEmoji, DependencyProxy::Blob, DependencyProxy::GroupSetting, DependencyProxy::Manifest, DeployKeysProject, DeployToken, Deployment, DeploymentCluster, DeploymentMergeRequest, DescriptionVersion, DesignManagement::Action, DesignManagement::Design, DesignManagement::Version, DevOpsReport::Metric, DiffNotePosition, DraftNote, Email, Environment, Epic, ErrorTracking::ProjectErrorTrackingSetting, Event, Experiment, ExperimentUser, ExternalPullRequest, ForkNetwork, ForkNetworkMember, Gitlab::BackgroundMigration::BackfillJiraTrackerDeploymentType2::JiraServiceTemp, Gitlab::BackgroundMigration::BackfillJiraTrackerDeploymentType2::JiraTrackerDataTemp, Gitlab::BackgroundMigration::MigrateIssueTrackersSensitiveData::IssueTrackerData, Gitlab::BackgroundMigration::MigrateIssueTrackersSensitiveData::JiraTrackerData, Gitlab::BackgroundMigration::UserMentions::Models::Namespace, Gitlab::Database::PartitioningMigrationHelpers::PartitionedForeignKey, Gitlab::DatabaseImporters::CommonMetrics::PrometheusMetric, GpgKey, GpgKeySubkey, GpgSignature, GrafanaIntegration, GroupCustomAttribute, GroupDeployKeysGroup, GroupDeployToken, GroupGroupLink, GroupImportState, Identity, ImportExportUpload, ImportFailure, IncidentManagement::ProjectIncidentManagementSetting, InternalId, IssuableSeverity, Issue, Issue::Metrics, IssueAssignee, IssueEmailParticipant, IssueLink, IssueTrackerData, Issues::CsvImport, Iteration, JiraConnectInstallation, JiraConnectSubscription, JiraImportState, JiraTrackerData, Key, Label, LabelLink, LabelPriority, LfsFileLock, LfsObject, LfsObjectsProject, List, ListUserPreference, Member, MergeRequest, MergeRequest::CleanupSchedule, MergeRequest::Metrics, MergeRequestAssignee, MergeRequestContextCommit, MergeRequestContextCommitDiffFile, MergeRequestDiff, MergeRequestDiffCommit, MergeRequestDiffFile, MergeRequestReviewer, MergeRequestsClosingIssues, Metrics::Dashboard::Annotation, Metrics::UsersStarredDashboard, Milestone, MilestoneRelease, Namespace, Namespace::AggregationSchedule, Namespace::RootStorageStatistics, NamespaceOnboardingAction, NamespaceSetting, Note, NoteDiffFile, NotificationSetting, OpenProjectTrackerData, Operations::FeatureFlag, Operations::FeatureFlagScope, Operations::FeatureFlags::Scope, Operations::FeatureFlags::Strategy, Operations::FeatureFlags::StrategyUserList, Operations::FeatureFlags::UserList, Operations::FeatureFlagsClient, Packages::BuildInfo, Packages::Composer::Metadatum, Packages::Conan::FileMetadatum, Packages::Conan::Metadatum, Packages::Dependency, Packages::DependencyLink, Packages::Event, Packages::Maven::Metadatum, Packages::Nuget::DependencyLinkMetadatum, Packages::Nuget::Metadatum, Packages::Package, Packages::PackageFile, Packages::PackageFileBuildInfo, Packages::Pypi::Metadatum, Packages::Tag, PagesDeployment, PagesDomain, PagesDomainAcmeOrder, PersonalAccessToken, Plan, PlanLimits, PoolRepository, Postgresql::ReplicationSlot, ProductAnalyticsEvent, ProgrammingLanguage, Project, ProjectAuthorization, ProjectAutoDevops, ProjectCiCdSetting, ProjectCustomAttribute, ProjectDailyStatistic, ProjectDeployToken, ProjectExportJob, ProjectFeature, ProjectFeatureUsage, ProjectGroupLink, ProjectImportData, ProjectImportState, ProjectMetricsSetting, ProjectPagesMetadatum, ProjectRepository, ProjectRepositoryStorageMove, ProjectSetting, ProjectStatistics, ProjectTracingSetting, PrometheusAlert, PrometheusAlertEvent, PrometheusMetric, ProtectedBranch, ProtectedBranch::MergeAccessLevel, ProtectedBranch::PushAccessLevel, ProtectedTag, ProtectedTag::CreateAccessLevel, PushEventPayload, RawUsageData, RedirectRoute, Release, Releases::Evidence, Releases::Link, RemoteMirror, RepositoryLanguage, ResourceEvent, Review, Route, SelfManagedPrometheusAlertEvent, SentNotification, SentryIssue, Serverless::DomainCluster, Service, ServiceDeskSetting, Shard, Snippet, SnippetRepository, SnippetStatistics, SpamLog, Subscription, Suggestion, SystemNoteMetadata, TermAgreement, Terraform::State, Terraform::StateVersion, Timelog, Todo, TrendingProject, U2fRegistration, Upload, User, UserAgentDetail, UserCallout, UserCanonicalEmail, UserCustomAttribute, UserDetail, UserHighestRole, UserInteractedProject, UserMention, UserPreference, UserStatus, UserSyncedAttributesMetadata, UsersStarProject, UsersStatistics, Vulnerability, WebHook, WebHookLog, WebauthnRegistration, WikiPage::Meta, WikiPage::Slug, X509Certificate, X509CommitSignature, X509Issuer, ZoomMeeting

Class Method Summary

• .at_most(count) ⇒ Object
• .id_in(ids) ⇒ Object
• .id_not_in(ids) ⇒ Object
• .iid_in(iids) ⇒ Object
• .pluck_primary_key ⇒ Object
• .primary_key_in(values) ⇒ Object
• .safe_ensure_unique(retries: 0) ⇒ Object
• .safe_find_or_create_by(*args, &block) ⇒ Object
• .safe_find_or_create_by!(*args, &block) ⇒ Object
• .underscore ⇒ Object
• .where_exists(query) ⇒ Object
• .with_fast_statement_timeout ⇒ Object

  Start a new transaction with a shorter-than-usual statement timeout.

• .without_order ⇒ Object

Class Method Details

.at_most(count) ⇒ Object

# File 'app/models/application_record.rb', line 45

def self.at_most(count)
  limit(count)
end

.id_in(ids) ⇒ Object

# File 'app/models/application_record.rb', line 12

def self.id_in(ids)
  where(id: ids)
end

.id_not_in(ids) ⇒ Object

# File 'app/models/application_record.rb', line 24

def self.id_not_in(ids)
  where.not(id: ids)
end

.iid_in(iids) ⇒ Object

# File 'app/models/application_record.rb', line 20

def self.iid_in(iids)
  where(iid: iids)
end

.pluck_primary_key ⇒ Object

# File 'app/models/application_record.rb', line 28

def self.pluck_primary_key
  where(nil).pluck(self.primary_key)
end

.primary_key_in(values) ⇒ Object

# File 'app/models/application_record.rb', line 16

def self.primary_key_in(values)
  where(primary_key => values)
end

.safe_ensure_unique(retries: 0) ⇒ Object

# File 'app/models/application_record.rb', line 32

def self.safe_ensure_unique(retries: 0)
  transaction(requires_new: true) do
    yield
  end
rescue ActiveRecord::RecordNotUnique
  if retries > 0
    retries -= 1
    retry
  end

  false
end

.safe_find_or_create_by(*args, &block) ⇒ Object

# File 'app/models/application_record.rb', line 67

def self.safe_find_or_create_by(*args, &block)
  safe_ensure_unique(retries: 1) do
    find_or_create_by(*args, &block)
  end
end

.safe_find_or_create_by!(*args, &block) ⇒ Object

# File 'app/models/application_record.rb', line 49

def self.safe_find_or_create_by!(*args, &block)
  safe_find_or_create_by(*args, &block).tap do |record|
    raise ActiveRecord::RecordNotFound unless record.present?

    record.validate! unless record.persisted?
  end
end

.underscore ⇒ Object

# File 'app/models/application_record.rb', line 73

def self.underscore
  Gitlab::SafeRequestStore.fetch("model:#{self}:underscore") { self.to_s.underscore }
end

.where_exists(query) ⇒ Object

# File 'app/models/application_record.rb', line 77

def self.where_exists(query)
  where('EXISTS (?)', query.select(1))
end

.with_fast_statement_timeout ⇒ Object

Start a new transaction with a shorter-than-usual statement timeout. This is currently one third of the default 15-second timeout

# File 'app/models/application_record.rb', line 59

def self.with_fast_statement_timeout
  transaction(requires_new: true) do
    connection.exec_query("SET LOCAL statement_timeout = 5000")

    yield
  end
end

.without_order ⇒ Object

# File 'app/models/application_record.rb', line 8

def self.without_order
  reorder(nil)
end